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.4.tar.gz
(41.9 kB
view details)
Built Distribution
nics-2.8.4-py3-none-any.whl
(48.2 kB
view details)
File details
Details for the file nics-2.8.4.tar.gz
.
File metadata
- Download URL: nics-2.8.4.tar.gz
- Upload date:
- Size: 41.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8acb3c236ecf478230525415a85439fb2d4fb2282d54fb923ff03576d240d288 |
|
MD5 | f2148cf9b8e86ee704d6bb537e372227 |
|
BLAKE2b-256 | 0ada2ad56b139e9e043a14e66b8d3297d82643d5c950557e2aaa7c0eb9b0545b |
File details
Details for the file nics-2.8.4-py3-none-any.whl
.
File metadata
- Download URL: nics-2.8.4-py3-none-any.whl
- Upload date:
- Size: 48.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9d68d9fe6d55dd5307d2c5d8b6ea2ec027efd6e33abfa2a0b498124da6e3297 |
|
MD5 | 3517ffca90f179795630463eee0cd9f6 |
|
BLAKE2b-256 | 8d998f9d1f575ea6e730939dedd39516cf08889ee41fc156d322f0340a09a16f |