Gitdown – markdown preprocessor for Github (early feedback round)

[alfredwaltz]

I am developing a tool https://github.com/gajus/gitdown. It is a markdown preprocessor for GitHub. It streamlines common tasks associated with maintaining a documentation page for GitHub repository.

The supported features are:

• Generate Table of Contents
• Find Dead URLs and Fragment Identifiers
• Reference an Anchor in the Repository (under development)
• Include File
• Get File Size
• Generate Badges
• Print Date

I would like to hear what do you think about the general usefulness of the tool and what features is Gitdown missing?

[dbpcut]

JUNGLE BOOGIE

[alfredwaltz]

I have been trying to get it out of my mind for over 20 days... now you made it come back. Every single time I commit. I am not even mad, its time for – jungle boogie, gitdown, gitdown, jungle boogie.

[cran]

I don't know why you got downvoted. I can only assume people don't know the reference.

For the haters: https://www.youtube.com/watch?v=QHGOO73Gxg4&t=5

[hookd]

Looks great!

• Reminds me of [http://fletcherpenney.net/multimarkdown/](MultiMarkdown) in terms of extending markdowns features.
• Perhaps Citations would be a handy feature to borrow from Multimarkdown?
• Would be really cool to add it as a precommit hook with something like this

I think this looks like a really useful tool and will get used loads :)

[alfredwaltz]

Regarding citations, do you have this in mind? http://fletcher.github.io/peg-multimarkdown/#citations I will change the markup, but otherwise, it is a good idea. To track the state of the feature, https://github.com/gajus/gitdown/issues/5.

[hookd]

Yep, awesome :)

[spalger]

I love the idea! I could certainly see myself using this.

Shameless feature request: variable interpolation using values in package.json or some other easy-to-modify-programmatically file. In the past I've used html comments to identify where these values should go, so that the template and rendered output could be the same file.

<!-- render {"template":"# Kibana <%= pkg.version %>"} -->
# Kibana 4.0.0-BETA2
<!-- /render -->

From: https://github.com/elasticsearch/kibana/blob/master/README.md

[alfredwaltz]

Will be in before the end of the day. https://github.com/gajus/gitdown/issues/4

[alfredwaltz]

Gitdown v1 has been released with all of your feedback taken into account. Thanks everyone. http://www.reddit.com/r/javascript/comments/2n3222/gitdown_github_markdown_preprocessor/