# Now I Can Sleep
A minimalist, readable, easy-to-configure, and markdown-based automated documentation workflow for GitHub repositories.
```txt
🐈BEFORE🐈
┌──────────> Make changes ────────────┐
| v
Deploy docs-page Update docs-files
^ │
└───────── Rebuild docs-page <────────┘
🐾with NICS🐾
┌──────────> Make changes ────────────┐
| |
└───────── Update docs-files <────────┘
```
[](https://github.com/nvfp/now-i-can-sleep/actions/workflows/rebuild-docs.yml)
[](https://pypi.org/project/nics/)
[](http://choosealicense.com/licenses/mit/)
## 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
- [Documentation](https://nvfp.github.io/now-i-can-sleep)
- [Changelog](https://nvfp.github.io/now-i-can-sleep/changelog)
- [💙Many Thanks](https://nvfp.github.io/now-i-can-sleep/many-thanks)
- [FAQ](https://nvfp.github.io/now-i-can-sleep/faqs)
## 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.
Raw data
{
"_id": null,
"home_page": "https://nvfp.github.io/now-i-can-sleep",
"name": "nics",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,toolkit,mykit",
"author": "Nicholas Valentinus",
"author_email": "nvfastplease@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0a/da/2ad56b139e9e043a14e66b8d3297d82643d5c950557e2aaa7c0eb9b0545b/nics-2.8.4.tar.gz",
"platform": null,
"description": "# Now I Can Sleep\n\nA minimalist, readable, easy-to-configure, and markdown-based automated documentation workflow for GitHub repositories.\n\n```txt\n\ud83d\udc08BEFORE\ud83d\udc08\n\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500> Make changes \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n | v\n\n Deploy docs-page Update docs-files\n\n ^ \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 Rebuild docs-page <\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\n\n\ud83d\udc3ewith NICS\ud83d\udc3e\n\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500> Make changes \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n | |\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 Update docs-files <\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n\n\n[](https://github.com/nvfp/now-i-can-sleep/actions/workflows/rebuild-docs.yml)\n[](https://pypi.org/project/nics/)\n[](http://choosealicense.com/licenses/mit/)\n\n\n## Installation\n\n1. Install via pip, run `pip install nics`\n2. Navigate to your project root folder\n3. Run `nics init`\n4. Follow the wizard, and you all set!\n\n\n## Links\n\n- [Documentation](https://nvfp.github.io/now-i-can-sleep)\n- [Changelog](https://nvfp.github.io/now-i-can-sleep/changelog)\n- [\ud83d\udc99Many Thanks](https://nvfp.github.io/now-i-can-sleep/many-thanks)\n- [FAQ](https://nvfp.github.io/now-i-can-sleep/faqs)\n\n\n## Troubleshoot\n\n- To report bugs or ask questions, please open an issue or submit a pull request.\n\n\n## License\n\nThis project is licensed under the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automated markdown-based documentation page workflow",
"version": "2.8.4",
"project_urls": {
"Changelog": "https://nvfp.github.io/now-i-can-sleep/changelog",
"Documentation": "https://nvfp.github.io/now-i-can-sleep/docs",
"Homepage": "https://nvfp.github.io/now-i-can-sleep",
"Report bugs": "https://github.com/nvfp/now-i-can-sleep/issues",
"Repository": "https://github.com/nvfp/now-i-can-sleep"
},
"split_keywords": [
"python",
"toolkit",
"mykit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d998f9d1f575ea6e730939dedd39516cf08889ee41fc156d322f0340a09a16f",
"md5": "3517ffca90f179795630463eee0cd9f6",
"sha256": "b9d68d9fe6d55dd5307d2c5d8b6ea2ec027efd6e33abfa2a0b498124da6e3297"
},
"downloads": -1,
"filename": "nics-2.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3517ffca90f179795630463eee0cd9f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 48166,
"upload_time": "2023-07-13T18:36:15",
"upload_time_iso_8601": "2023-07-13T18:36:15.944906Z",
"url": "https://files.pythonhosted.org/packages/8d/99/8f9d1f575ea6e730939dedd39516cf08889ee41fc156d322f0340a09a16f/nics-2.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ada2ad56b139e9e043a14e66b8d3297d82643d5c950557e2aaa7c0eb9b0545b",
"md5": "f2148cf9b8e86ee704d6bb537e372227",
"sha256": "8acb3c236ecf478230525415a85439fb2d4fb2282d54fb923ff03576d240d288"
},
"downloads": -1,
"filename": "nics-2.8.4.tar.gz",
"has_sig": false,
"md5_digest": "f2148cf9b8e86ee704d6bb537e372227",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41884,
"upload_time": "2023-07-13T18:36:17",
"upload_time_iso_8601": "2023-07-13T18:36:17.312938Z",
"url": "https://files.pythonhosted.org/packages/0a/da/2ad56b139e9e043a14e66b8d3297d82643d5c950557e2aaa7c0eb9b0545b/nics-2.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-13 18:36:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nvfp",
"github_project": "now-i-can-sleep",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "nics"
}
JSON
