Pages

▼

Tuesday, 24 June 2014

文档生成器-daux.io(其实也是一个静态网站程序）

Daux.io is an 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.http://daux.io

Features

  • 100% Mobile Responsive
  • Supports GitHub Flavored Markdown
  • Auto created homepage/landing page
  • Auto Syntax Highlighting
  • Auto Generated Navigation
  • 4 Built-In Themes or roll your own
  • Functional, Flat Design Style
  • Shareable/Linkable SEO Friendly URLs
  • Built On Bootstrap
  • No Build Step
  • Git/SVN Friendly
  • Supports Google Analytics and Piwik Analytics
  • Optional code float layout
  • Static Output Generation

Demos

This is a list of sites using Daux.io:
Do you use Daux.io? Send me a pull request or open an issue and I will add you to the list.

Download

Download this repository as a zip, and unpack. Copy the files to a web server that can run PHP 5.3 or greater. You can also run the documentation locally using Grunt.js, which is covered at the end of this readme.

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 config.json file.

Files

The generator will look for Markdown *.md files inside the /docs folder and any of the subfolders within /docs.
You must use the .md file extension for your files. Also, 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
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.

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": "img/app.png"
}
Note: The image can be a local or remote image.

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.

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"
}

Docs Path:

If you'd prefer to keep your docs outside of the Daux.io directory, you can provide the filepath.
Note: Your config.json file will need to remain in /daux.io/docs.
{
    "docs_path": "../../my_docs"
} 
 
from https://github.com/justinwalsh/daux.io
at