Automated markdown-based documentation page workflow
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nics-2.8.1.tar.gz
(41.8 kB
view details)
Built Distribution
nics-2.8.1-py3-none-any.whl
(48.1 kB
view details)
File details
Details for the file nics-2.8.1.tar.gz
.
File metadata
- Download URL: nics-2.8.1.tar.gz
- Upload date:
- Size: 41.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e981f9e279f7e6f23a5593e8e5e237a7791cb146f60c3f5ba33c40e53900e3ed |
|
MD5 | ad58dfeb23ed066d00fffffa1aa5607f |
|
BLAKE2b-256 | e77a569b386e60c55ab92d88791a44c72afe26adc96d0c613b50080611abae36 |
File details
Details for the file nics-2.8.1-py3-none-any.whl
.
File metadata
- Download URL: nics-2.8.1-py3-none-any.whl
- Upload date:
- Size: 48.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 674f82b437b60d981f7584d1869c32f2ea89e5d0338388dcc476fe66b4e8e643 |
|
MD5 | 5433fc32d0773204ab4120e56a65576b |
|
BLAKE2b-256 | a16086df4e658605c7feca13d8a14c886b9d8d082568db3b3940d2df4e398a38 |