Now I Can Sleep
A minimalist, readable, easy-to-configure, and markdown-based automated documentation workflow for GitHub repositories.
🐈BEFORE🐈
┌──────────> Make changes ────────────┐
| v
Deploy docs-page Update docs-files
^ │
└───────── Rebuild docs-page <────────┘
🐾with NICS🐾
┌──────────> Make changes ────────────┐
| |
└───────── Update docs-files <────────┘


Installation
- Install via pip, run
pip install nics
- Navigate to your project root folder
- Run
nics init
- Follow the wizard, and you all set!
Links
Troubleshoot
- To report bugs or ask questions, please open an issue or submit a pull request.
License
This project is licensed under the MIT license.