nanodocs
v1.0.1
Published
## What is NanoDocs?
Downloads
7
Readme
NanoDocs
What is NanoDocs?
NanoDocs is a tool for generating online documentation.
You write your documentation in Markdown format, and NanoDocs combines the files into a single-page app that you can host wherever you like.
The full documentation is a great example of what can be achieved with the default settings.
Why a single-page app?
If your documentation exists as a collection of multiple web pages, users can't access it offline.
NanoDocs allows users to download your documentation (including images) as a single HTML file, which can be opened by any browser without the need for an internet connection.
Look and feel
NanoDocs ships with multiple themes, each of which supports multiple colour modes and text resizing.
Take a look at some examples in the themes guide.
Getting started
To learn how NanoDocs works, try working through the example project.