Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allnulled/bookmator
Create one markdown file. But using filesystem folders, and recursion. Powerful.
https://github.com/allnulled/bookmator
Last synced: 1 day ago
JSON representation
Create one markdown file. But using filesystem folders, and recursion. Powerful.
- Host: GitHub
- URL: https://github.com/allnulled/bookmator
- Owner: allnulled
- Created: 2020-04-28T13:58:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-29T06:50:23.000Z (over 4 years ago)
- Last Synced: 2024-10-31T18:58:12.056Z (17 days ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/bookmator
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bookmator
Generate markdown from filesystem recursion. Useful to maintain big markdown documents.
[](https://www.npmjs.com/package/bookmator)
## Installation
```sh
$ npm i -g bookmator
```
## Get started
### Instructions
- 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.*
### Demo
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
```
## Usage
### From CLI
```sh
$ bookmator compile docs/README.md
```
### From api
```js
require("bookmator").compile("docs/README.md");
```
## License
This project is licensed under [WTFPL](https://es.wikipedia.org/wiki/WTFPL), which stands for *Do What The Fuck You Want To Public License*.
## Versioning
This project adheres to [semantic versioning 2.0](https://semver.org/).
## Issues
To communicate issues [here](https://github.com/allnulled/bookmator/issues/new).