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.4.tar.gz (41.9 kB view hashes)

Uploaded Source

Built Distribution

nics-2.8.4-py3-none-any.whl (48.2 kB view hashes)

Uploaded Python 3

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