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.3.tar.gz (41.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nics-2.8.3.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.3.tar.gz
Algorithm Hash digest
SHA256 a675f9bebb787e4b3a91d7f483d19100aa5d201ceefd2654d7b99f21980ed79e
MD5 501a35df8d646e787df524277f477fd9
BLAKE2b-256 e0f396beec082bea813f7e2a5361ee54d16383056f6320553655154bbccdd5f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nics-2.8.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d799895747d217c701904594f021658e5ee7f76ea701c01e6def5e78598750d1
MD5 945c6d963ddc4be0eea498e314a30121
BLAKE2b-256 2488105ab3b419c243329e4ae6deebbc0f4ebf05739e4a26868112f57b3b4561

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