Skip to main content

A rapid documentation tool to blow you away.

Project description


A rapid documentation tool to blow you away.

Docnado makes it easy to start and maintain a Markdown documentation project. Store your own data your own way.

PyPI version

Basic Features

Docnado renders an adapted Markdown to provide:

  • Images, Video, YouTube links, CSV tables.
  • Code highlighting.
  • File download blocks.
  • Lists and Tables.
  • Document defined template selection.
  • Document Meta-data.
  • Auto-generated index sidebar.

Docnado can:

  • Output documents as insecure HTML on a localhost.
  • Output documents as PDF files via the HTML server.
  • Create a static set of HTML files that contain the documentation and related resources.

Advanced Features

  • Automatically find broken reference links in the generated HTML
  • Automatically find orphan files (i.e. images) that are not referenced by generated HTML


Basic usage with the default template:

python -m pip install docnado --upgrade
mkdir docs
vim docs/ # then add some documentation

Advanced usage with a custom templates and styles:

python -m pip install docnado --upgrade
docnado --new # copies sample style and docs into working directory
docnado # run the server

Getting Started

If you are running from the script:

python                       # start a server on localhost:5000

python -h                    # list argument help

python --html                # freeze the server into a static site as a set of HTML files
                                        # this will exit with -1 if there was a problem parsing any file

python --pdf                 # generate a set of pdf files for each .md file - won't pull through
                                        # static resource files like with the --html command

python --nav-limit           # include certain document trees only based on a comma separated list of
                                        # nav strings. e.g. Tooling,Document

python --new                 # copy default templates and sample docs into the working directory
                                        # and update the config too, only if they don't already exist

python --new-force           # copy default templates and sample docs into the working directory
                                        # and update the config too, this will overwrite any existing docs or
                                        # configs.

python --dirs                # display all the different directories Docnado will use to generate
                                        # the documentation

python --generate-meta DIR   # generate metadata for markdown files in the specified directory

python --find-orphans        # display unreferenced media assets in the documentation

python --find-broken-links   # display external broken links in the documentation

python --port PORTNUMBER     # specify a port for Docnado to accept requests on

python --host HOSTADDRESS    # set the docnado development server to listen on a specified IP address.
                                        # use '' to listen on all available IPs

Writing Documentation

Documents are managed using meta-data at the top of each document. Documents can select which template they present themselves with. Documents must end in lowercase .md. For example:

Environment Variables

  • DN_FLASK_DEBUG flag for enabling or disabling flask debug. Defaults to TRUE.
  • DN_RELOAD_ON_CHANGES flag for reloading the server when a file changes. Defaults to TRUE.
  • DN_WKHTMLTOPDF the path to the WkHTMLtoPDF binary. Defaults to wkhtmltopdf_0.12.5.exe.
  • DN_DOCS_DIR the path to the directory that contains the documents. Defaults to docs.
  • DN_STYLE_DIR the path to the directory that contains the style templates and resources. Defaults to style.
  • DN_PROJECT_LOGO the path to the project logo PNG file. Defaults to logo.png in the current working directory.


Virtual Environment

python -m virtualenv env
env/Scripts/activate.bat # or the bash equivalent
pip install -r requirements.txt
python # with options
pip install flake8
flake8 --max-line-length=120


To enable PDF output, WkHTMLtoPDF must be set in the config DN_WKHTMLTOPDF or wkhtmltopdf_0.12.5.exe placed in working directory.

This build uses version 0.12.5. Get it from here:


The default theme is built using SCSS.

The SASSC compiler can be found here: Usage: sassc style/static/default.scss style/static/default.css

If you want it to auto-watch, run as admin from this directory, and remember to disable your browser cache:

pip install watchdog
watchmedo shell-command --patterns="*.scss" --recursive --command='echo "${watch_src_path}" && sassc style/static/default.scss style/static/default.css' .


We use flake8 --max-line-length=110 to static check the code.

Rebuilding the Package


python -m pip install --user --upgrade setuptools wheel twine
python sdist bdist_wheel

python -m twine upload dist/*


pip install pyinstaller


We are requesting pull-requests for the following features:

  • <input type="checkbox" disabled="" /> Test cases and CI steps
  • <input type="checkbox" disabled="" /> Responsive design in default template.
  • <input type="checkbox" disabled="" /> Generate a large PDF file made from multiple documents (including table of contents with page numbers).
  • <input type="checkbox" disabled="" /> Gravatar print CSS / absent internet in the default theme.
  • <input type="checkbox" disabled="" /> Examples of Python extensions and SCSS extensions.
  • <input type="checkbox" disabled="" /> New template themes.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for docnado, version 1.0.10
Filename, size File type Python version Upload date Hashes
Filename, size docnado-1.0.10-py3-none-any.whl (5.8 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size docnado-1.0.10.tar.gz (5.8 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page