Daux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
Download this repository as a zip, unpack, and put your documentation in the docs folder, you can then serve it with Apache or Nginx.
daux
The command line tool has two commands: generate and serve, running Daux.io without an argument will automatically run the generate command.
You can run daux --help to get more details about each command.
Folders
By default, the generator will look for folders in the docs folder. Add your folders inside the docs folder. This project contains some example folders and files to get you started.
You can nest folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the global.json file.
Files
The generator will look for Markdown files (*.md and *.markdown) inside the docs folder and any of the subfolders within docs.
You must use underscores instead of spaces. Here are some example file names and what they will be converted to:
Good:
01_Getting_Started.md = Getting Started
API_Calls.md = API Calls
200_Something_Else-Cool.md = Something Else-Cool
_5_Ways_to_Be_Happy.md = 5 Ways To Be Happy
Bad:
File Name With Space.md = FAIL
Sorting
To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. /docs/01_Hello_World.md and /docs/05_Features.md This will list Hello World before Features, overriding the default alpha-numeric sorting. The numbers will be stripped out of the navigation and urls. For the file 6 Ways to Get Rich, you can use /docs/_6_Ways_to_Get_Rich.md
Landing page
If you want to create a beautiful landing page for your project, simply create a index.md file in the root of the /docs folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:
{
"title": "Daux.io",
"tagline": "The Easiest Way To Document Your Project",
"image": "app.png"
}
Note: The image can be a local or remote image. Use the convention <base_url> to refer to the root directory of the Daux instance.
Section landing page
If you are interested in having a landing page for a subsection of your docs, all you need to do is add an index.md file to the folder. For example, /docs/01_Examples has a landing page for that section since there exists a /docs/01_Examples/index.md file. If you wish to have an index page for a section without a landing page format, use the name _index.md
Configuration
To customize the look and feel of your documentation, you can create a config.json file in the of the /docs folder.
The config.json file is a simple JSON object that you can use to change some of the basic settings of the documentation.
Title
Change the title bar in the docs
{
"title": "Daux.io"
}
Themes
We have 4 built-in Bootstrap themes. To use one of the themes, just set the theme option to one of the following:
客服电话
APP下载
官方微信
请发表评论