Generate markdown from filesystem recursion. Useful to maintain big markdown documents.
$ npm i -g bookmator
-
Any
markdown
(*.md
) file passed (or found in the process) is replaced by its correspondant folder if its folder is found: otherwise, it keeps the code. -
The 'correspondant folder' is a folder with the same name of the (
*.md
) file, but without the extension.md
.
Note: so, consider that the file that you pass to bookmator
could be overriden, if its folder is found.
This could perfectly be a senseful tree for bookmator
:
/book-1/
/book-1/index.md (this is overriden)
/book-1/index/
/book-1/index/001.introduction.md
/book-1/index/002.installation.md
/book-1/index/003.get-started.md
/book-1/index/004.usage.md
/book-1/index/005.examples.md (this is overriden)
/book-1/index/005.examples/001.simple.md
/book-1/index/005.examples/002.common.md
/book-1/index/005.examples/003.advanced.md
/book-1/index/006.reference.md (this is overriden)
/book-1/index/006.reference/
/book-1/index/007.license.md
/book-1/index/008.versioning.md
/book-1/index/009.issues.md
$ bookmator compile docs/README.md
require("bookmator").compile("docs/README.md");
This project is licensed under WTFPL, which stands for Do What The Fuck You Want To Public License.
This project adheres to semantic versioning 2.0.
To communicate issues here.