A GitHub Flavored Markdown preprocessor that adds table of contents, file includes, variables, badges, and more using JSON syntax.
Gitdown is a Node.js-based preprocessor that extends GitHub Flavored Markdown with additional functionality like generating table of contents, including files, using variables, and creating badges. It solves the problem of maintaining static documentation by allowing dynamic content generation and validation directly within markdown files.
Developers and technical writers who maintain project documentation on GitHub and want to automate repetitive tasks, ensure link validity, and keep documentation consistent.
Developers choose Gitdown because it seamlessly integrates with existing GitHub workflows, provides a rich set of built-in helpers, and allows extensibility through custom helpers, making documentation maintenance efficient and error-free.
GitHub markdown preprocessor.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates nested table of contents with configurable depth and root sections, using the markdown-contents library as detailed in the README.
Integrates Deadlink to check URLs and fragment identifiers, throwing errors for broken links to ensure documentation accuracy.
Allows registration of custom helpers with weight-based processing order, enabling project-specific markdown extensions as shown in the syntax section.
Automatically creates badges for services like npm and Travis using shields.io, based on environment variables and package.json.
The anchor reference feature is explicitly marked as under development in the README, limiting its immediate usefulness for code documentation.
Requires embedding JSON objects within markdown, which clutters the source and reduces readability compared to standard markdown syntax.
Requires a Node.js environment for processing, adding setup complexity and dependencies that may not be needed in all projects.