Last Updated: February 25, 2016
· gajus

Using Github markdown preprocessor to streamline common tasks associated with managing documentation

Gitdown is a markdown preprocessor for Github. In essence – it is a tool wrapping a collection of processing utilities used to streamline documentation writing on Github, e.g.

  • Generate Table of Contents
  • Find dead URLs and Fragment Identifiers
  • Include variables
  • Include files
  • Get file size
  • Generate Badges
  • Print Date
  • Print information about the repository itself

Furthermore, you can write your own extensions, such as this example illustrating a user extension for including https://gist.github.com/ to your markdown, https://github.com/gajus/gitdown/issues/7.

Gitdown is designed to be run using either of the build systems, such as Gulp or Grunt. It seamlessly integrates into your development routine.

Say Thanks