{"id":13856737,"url":"https://github.com/HEInventions/docnado","last_synced_at":"2025-07-13T19:32:34.355Z","repository":{"id":41579854,"uuid":"152275505","full_name":"HEInventions/docnado","owner":"HEInventions","description":"Rapid documentation tool that will blow you away...","archived":false,"fork":false,"pushed_at":"2023-05-22T23:19:42.000Z","size":10695,"stargazers_count":90,"open_issues_count":6,"forks_count":11,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-15T06:51:54.369Z","etag":null,"topics":["docs","documentation","flask","markdown","pdf","static-site-generator","tool"],"latest_commit_sha":null,"homepage":"https://heinventions.github.io/docnado-site/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HEInventions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-09T15:27:15.000Z","updated_at":"2024-11-10T21:51:22.000Z","dependencies_parsed_at":"2024-11-15T06:52:11.554Z","dependency_job_id":"55b2cdf6-c63d-4454-833f-e86c12ca2c2a","html_url":"https://github.com/HEInventions/docnado","commit_stats":{"total_commits":42,"total_committers":9,"mean_commits":4.666666666666667,"dds":0.5714285714285714,"last_synced_commit":"7e474a34036248fa773f9487be21252db03a7b5f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HEInventions%2Fdocnado","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HEInventions%2Fdocnado/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HEInventions%2Fdocnado/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HEInventions%2Fdocnado/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HEInventions","download_url":"https://codeload.github.com/HEInventions/docnado/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225912240,"owners_count":17544131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","flask","markdown","pdf","static-site-generator","tool"],"created_at":"2024-08-05T03:01:11.200Z","updated_at":"2024-11-22T14:30:42.351Z","avatar_url":"https://github.com/HEInventions.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# docnado\n\nA rapid documentation tool to blow you away.\n\nDocnado makes it easy to start and maintain a Markdown documentation project.  Store your own data your own way.\n\n[![PyPI version](https://badge.fury.io/py/docnado.svg)](https://badge.fury.io/py/docnado)\n\n# Basic Features\n\nDocnado renders an adapted Markdown to provide:\n\n* Images, Video, YouTube links, CSV tables.\n* Code highlighting.\n* File download blocks.\n* Lists and Tables.\n* Document defined template selection.\n* Document Meta-data.\n* Auto-generated index sidebar.\n\nDocnado can:\n\n* Output documents as insecure HTML on a localhost.\n* Output documents as PDF files via the HTML server.\n* Create a **static** set of HTML files that contain the documentation and related resources.\n\n# Advanced Features\n\n* Automatically find broken reference links in the generated HTML\n* Automatically find orphan files (i.e. images) that are not referenced by generated HTML\n\n# Usage\n\nBasic usage with the default template:\n\n```bash\npython -m pip install docnado --upgrade\nmkdir docs\nvim docs/home.md # then add some documentation\ndocnado\n```\n\nAdvanced usage with a custom templates and styles:\n\n```bash\npython -m pip install docnado --upgrade\ndocnado --new # copies sample style and docs into working directory\ndocnado # run the server\n```\n\n## Getting Started\n\nIf you are running from the script:\n\n```bash\npython docnado.py                       # start a server on localhost:5000\n\npython docnado.py -h                    # list argument help\n\npython docnado.py --html                # freeze the server into a static site as a set of HTML files\n                                        # this will exit with -1 if there was a problem parsing any file\n\npython docnado.py --pdf                 # generate a set of pdf files for each .md file - won't pull through\n                                        # static resource files like with the --html command\n\npython docnado.py --nav-limit           # include certain document trees only based on a comma separated list of\n                                        # nav strings. e.g. Tooling,Document\n\npython docnado.py --new                 # copy default templates and sample docs into the working directory\n                                        # and update the config too, only if they don't already exist\n\npython docnado.py --new-force           # copy default templates and sample docs into the working directory\n                                        # and update the config too, this will overwrite any existing docs or\n                                        # configs.\n\npython docnado.py --dirs                # display all the different directories Docnado will use to generate\n                                        # the documentation\n\npython docnado.py --generate-meta DIR   # generate metadata for markdown files in the specified directory\n\npython docnado.py --find-orphans        # display unreferenced media assets in the documentation\n\npython docnado.py --find-broken-links   # display external broken links in the documentation\n\npython docnado.py --port PORTNUMBER     # specify a port for Docnado to accept requests on\n\npython docnado.py --host HOSTADDRESS    # set the docnado development server to listen on a specified IP address.\n                                        # use '0.0.0.0' to listen on all available IPs\n```\n\n### Writing Documentation\n\nDocuments are managed using `meta-data` at the top of each document.\nDocuments can select which `template` they present themselves with.\nDocuments must end in **lowercase** `.md`. For example: `mydocument.md`.\n\n\n### Environment Variables\n\n* `DN_FLASK_DEBUG` flag for enabling or disabling flask debug. Defaults to `TRUE`.\n* `DN_RELOAD_ON_CHANGES` flag for reloading the server when a file changes. Defaults to `TRUE`.\n* `DN_WKHTMLTOPDF` the path to the WkHTMLtoPDF binary. Defaults to `wkhtmltopdf_0.12.5.exe`.\n* `DN_DOCS_DIR` the path to the directory that contains the documents. Defaults to `docs`.\n* `DN_STYLE_DIR` the path to the directory that contains the style templates and resources. Defaults to `style`.\n* `DN_PROJECT_LOGO` the path to the project logo *PNG* file. Defaults to `logo.png` in the current working directory.\n\n## Development\n\n### Virtual Environment\n\n```bash\npython -m virtualenv env\nenv/Scripts/activate.bat # or the bash equivalent\npip install -r requirements.txt\n```\n\n```bash\npython docnado.py # with options\n```\n\n```bash\npip install flake8\nflake8 docnado.py --max-line-length=120\n```\n\n### WkHTMLtoPDF\n\nTo enable PDF output, WkHTMLtoPDF must be set in the config `DN_WKHTMLTOPDF` or `wkhtmltopdf_0.12.5.exe` placed in working directory.\n\nThis build uses version 0.12.5. Get it from here: https://wkhtmltopdf.org/downloads.html\n\n### SCSS\n\nThe default theme is built using SCSS.\n\nThe SASSC compiler can be found here: http://libsass.ocbnet.ch/installer/\nUsage: `sassc style/static/default.scss style/static/default.css`\n\nIf you want it to auto-watch, run as admin from this directory, and remember to disable your browser cache:\n\n```bash\npip install watchdog\nwatchmedo shell-command --patterns=\"*.scss\" --recursive --command='echo \"${watch_src_path}\" \u0026\u0026 sassc style/static/default.scss style/static/default.css' .\n````\n\n### Style\n\nWe use `flake8 docnado.py --max-line-length=110` to static check the code.\n\n### Rebuilding the Package\n\nPyPi\n\n```bash\npython -m pip install --user --upgrade setuptools wheel twine\npython setup.py sdist bdist_wheel\n\npython -m twine upload dist/*\n```\n\nExecutable\n\n```bash\nenv\\Scripts\\activate.bat\npip install pyinstaller\npyinstaller docnado.py\n```\n\n## Roadmap\n\nWe are requesting pull-requests for the following features:\n\n* [ ] Test cases and CI steps\n* [ ] Responsive design in default template.\n* [ ] Generate a large PDF file made from multiple documents (including table of contents with page numbers).\n* [ ] Gravatar print CSS / absent internet in the default theme.\n* [ ] Examples of Python extensions and SCSS extensions.\n* [ ] New template themes.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHEInventions%2Fdocnado","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHEInventions%2Fdocnado","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHEInventions%2Fdocnado/lists"}