Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bafs/documentor
Super intuitive documentation generator, from markdown files to a single html file (style, scripts, images, search engine embedded) 📖
https://github.com/bafs/documentor
documentation documentation-tool documentator markdown static-site-generator
Last synced: about 10 hours ago
JSON representation
Super intuitive documentation generator, from markdown files to a single html file (style, scripts, images, search engine embedded) 📖
- Host: GitHub
- URL: https://github.com/bafs/documentor
- Owner: BafS
- Created: 2017-10-31T00:14:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T21:15:12.000Z (over 1 year ago)
- Last Synced: 2023-03-31T11:58:12.095Z (over 1 year ago)
- Topics: documentation, documentation-tool, documentator, markdown, static-site-generator
- Language: JavaScript
- Homepage: https://bafs.github.io/Documentor
- Size: 399 KB
- Stars: 35
- Watchers: 3
- Forks: 4
- Open Issues: 16
-
Metadata Files:
- Readme: Readme.md
- Changelog: Changelog.md
Awesome Lists containing this project
README
> A super intuitive doc generator from Markdown files
# Installation
```sh
npm -g i documentor
```
or for yarn users: `yarn global add documentor`
## Quick Usage
```sh
documentor init # initialisation of the documentation
```
```sh
documentor ./docs-folder -o output.html # render the documentation to output.html
```
# [Documentation](http://bafs.github.io/Documentor)
Please check the [**documentation**](http://bafs.github.io/Documentor) for more details.
## Command Line Usage
- **`-i`**, **`--input`**: Input folder (optional flag)
- **`-o`**, **`--output`**: Write in file
- **`-t`**, **`--to`**: Output format
- **`-c`**, **`--config`**: Configuration file
- **`-w`**, **`--watch`**: Watch docs files with partial generation
- **`-q`**, **`--quite`**: Do not output any message
- **`-v`**, **`--verbose`**: Increase the verbosity
- **`--var`**, **`--variable`**: Set or override config variable(s)
- **`-h`**, **`--help`**: Show help
### Examples
Generate `project.html` from `./docs` folder
```sh
documentor ./docs -o out.html
```
Output html to STDOUT from `./docs` folder and read the configuration file `conf.yml`
```sh
documentor docs -c conf.yml
```
Generate "out.html" with a custom name and footer
```sh
documentor ./docs -o out.html --var.name "My Project" --var.footer "(c) Project 1.0"
```
Watch the "docs" folder and regenerate "out.html" on change
```sh
documentor docs -o out.html -w
```
## Dev
```sh
npm i
```
You can run the CLI version with `node bin/documentor.js`, for example `node bin/documentor.js ./docs -o out.html`.
### Test
```sh
npm test
```
# Screenshot
#### TODO
- [ ] Embed images from markdown
- [ ] Add processing indicator