Skip to main content

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  <โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

nics' banner

Rebuild docs pypi version MIT License

Installation

  1. Install via pip, run pip install nics
  2. Navigate to your project root folder
  3. Run nics init
  4. 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.2.tar.gz (41.8 kB view details)

Uploaded Source

Built Distribution

nics-2.8.2-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

Details for the file nics-2.8.2.tar.gz.

File metadata

  • Download URL: nics-2.8.2.tar.gz
  • Upload date:
  • Size: 41.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for nics-2.8.2.tar.gz
Algorithm Hash digest
SHA256 9443f4c7a7cf251ef6b40d2aef4b34fe2ea3ccbe6960466480f37792d657cb71
MD5 3c4cca4a74344060fac770759db3c249
BLAKE2b-256 ed5253e4ea2f56130c4685390cbc97d0efe018dbe3224e5d15f5fae413b4620b

See more details on using hashes here.

File details

Details for the file nics-2.8.2-py3-none-any.whl.

File metadata

  • Download URL: nics-2.8.2-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.17

File hashes

Hashes for nics-2.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4696ba1b5f0671e732d29f8f7aa1143fa43cfeff2037244f892ba375293935be
MD5 64a7d13ea240069cae64f14e1f5c3537
BLAKE2b-256 57374f9fb0047a156337d10aa182d323c2a8e211705dcb4b3aee691af3994b59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page