Generates Github wiki from a book of markdown topics.
npm install github-wiki-from-markdown-bookLoads and collates markdown topic files using a YAML encoded book that organizes the
topics into a book. This is sort of like a highly watered down version of DITA.
>
> Important - There are no unit tests yet.
>
``sh`
$ npm install --save-dev github-wiki-from-markdown-book
`sh`
$ github-wiki-from-markdown-book build --source=markdown-book.yaml --output=./wiki
| Argument | Description |
|----------------|:----------------------------------------------------------------------|
| --input | Path to the YAML input file that composes the markdown book. |--output
| | Output path for generated Github wiki pages. |--help
| | Shows usage information. |
`sh`
$ github-wiki-from-markdown-book clean --output=./wiki
| Argument | Description |
|----------------|:----------------------------------------------------------------------|
| --input | Path to the YAML input file that composes the markdown book. |--output
| | Output path for generated Github wiki pages. |--help
| | Shows usage information. |
`yaml
title: Example Book
author: Joe Bloggs
# Chapter: User Interface
- source: ./topics/User-Interface.md
topics:
# Sub-topics
- source: ./topics/Main-Window.md
topics:
# Going deeper! sub-topics of "Main Window".
- source: ./topics/Toolbar.md
- source: ./topics/Status-Panel.md
- source: ./topics/Viewports.md
- source: ./topics/Create-Viewport.md
This project is licensed under the MIT license (see LICENSE). To be in the best
position to enforce these licenses the copyright status of this project needs to
be as simple as possible. To achieve this the following terms and conditions
must be met:
- All contributed content (including but not limited to source code, text,
image, videos, bug reports, suggestions, ideas, etc.) must be the
contributors own work.
- The contributor disclaims all copyright and accepts that their contributed
content will be released to the public domain.
- The act of submitting a contribution indicates that the contributor agrees
with this agreement. This includes (but is not limited to) pull requests, issues,
tickets, e-mails, newsgroups, blogs, forums, etc.