loading...

Bookmator: markdown + filesystem recursion

allnulled profile image allnulled ・1 min read

Hi, sis and bros.

Yesterday, I released a tool to generate a markdown file from filesystem tree.

This tool can be useful to maintain big markdown files, because it lets us split our contents in different files and folders.

Installation

$ npm install --global bookmator

Usage

Suposing this file tree:

/README.md
/README/0.introduction.md
/README/1.contents.md
/README/2.end.md

We could generate our README file like this:

$ bookmator compile README.md

The tool, everytime it matches a md file, will look always for a folder named the same way but without the extension (.md). When it is found, the contents of the file are replaced by the contents in the markdown files of the folder. These inner files can follow the same pattern too.

That is all, this is a very simple tool.

Happy documentation!

Discussion

markdown guide