markdown-mutute v0.1.1

Markdown mutate

The main page

Document pages

• License information
• The todo list
• Using the command

Author: Robert Steckroth, Bustout

License: MIT

Bonuses:

• Tested in Ubuntu 16.04 and Windows 10
• Integrates git repository information
• Script runs as a command from anywhere on the system or locally as a nodejs script
• Document pages are valid markdown documents before and after mutation
• Script is idempotent while maintaining individual changes to pages.
• Branch specific urls so branches maintain own unique documentation commits
• Well commented, professional code

Caveats:

• Only works with git based projects

This module provides an idempotent script/shell command that injects navigation list syntax into markdown pages. The pages are collected from a directory in the git project and link urls are created which reference them.

Below is the markdown page before and after mutation:

# My module
## The main page

Some text about the project here

After running the markdown_mutate command/script:

# My module
## The main page

----
### Document pages
* [License information](https://github.com/username/project/blob/master/doc/license.md)
* [The todo list](https://github.com/username/project/blob/master/doc/todo.md)
* [Using the command](https://github.com/username/project/blob/master/doc/usage.md)

----

Some text about the project here