@congcongcai/doc-on-repository
v0.0.3
Published
Use multiple formats to write and manage documents in a git-managed repository
Readme
documents on repository
This app want to help developer using multiple formats to write and manage documents in a git-managed repository It is helpful to prevent inconsistencies between code and documentation and give AI tooling more hint.
Key Feature
- Render
- [x] create index page automatically
- [x] render markdown (by markdown-it)
- [x] render ppt (by reveal.js)
- [ ] render mermaid charting
- [ ] render draw.io
- Real-Time
- [x] sync file change to html
- [ ] allow edit in html
Usage
To run the application, use the following command:
npm startUsage: index [options]
Options:
-p, --port <number> port number (default: "3000")
--root <folder> document folder (default: "doc")
-h, --help display help for commandContributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
License
This project is licensed under the MPL-2.0 License. See the LICENSE file for more details.
