8.1 KiB
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.
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
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
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.
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.
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:
- blue
- green
- navy
- red
{
"theme": "blue"
}
###Custom Theme:
To create a custom color scheme, set the theme property to custom and then define the required colors. Copy the following configuration to get started:
{
"theme": "custom",
"colors": {
"sidebar-background": "#f7f7f7",
"sidebar-hover": "#c5c5cb",
"lines": "#e7e7e9",
"dark": "#3f4657",
"light": "#82becd",
"text": "#2d2d2d",
"syntax-string": "#022e99",
"syntax-comment": "#84989b",
"syntax-number": "#2f9b92",
"syntax-label": "#840d7a"
}
}
###Code Floating:
By deafult your code blocks will be floated to a column on the right side of your content. To disable this feature, set the float property to false.
{
"float": false
}
###GitHub Repo: Add a 'Fork me on GitHub' ribbon.
{
"repo": "justinwalsh/daux.io"
}
###Twitter: Include twitter follow buttons in the sidebar.
{
"twitter": ["justin_walsh", "todaymade"]
}
###Links: Include custom links in the sidebar.
{
"links": {
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
"Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
"Made by Todaymade": "http://todaymade.com"
}
}
###Google Analytics: This will embed the google analytics tracking code.
{
"google_analytics": "UA-XXXXXXXXX-XX"
}
###Piwik Analytics: This will embed the piwik tracking code.
{
"piwik_analytics": "my-url-for-piwik.com"
}
###Ignore:
Set custom files and entire folders to ignore within your /docs folder. For files make sure to include the file extension in the name. For both files and folders, names are case-sensitive.
{
"ignore": {
"files": ["Work_In_Progress.md"],
"folders": ["99_Not_Ready"]
}
}
###Disabling clean URLs By default, Daux.io will create clean url's that do not include index.php. On servers running Apache, uploading the included .htaccess file should be enough for them to work properly. On servers that are not running Apache or that do not allow custom .htaccess files, you may need to disable clean_urls:
{
"clean_urls": false
}
Running Remotely
Copy the files from the repo to a web server that can run PHP 5.3 or greater.
Running Locally
There are several ways to run the docs locally. You can use something like MAMP or WAMP. If you are like me and use alot of Node.js and Grunt.js, then you can use the optional grunt command I have packaged with the project which will start a PHP web server for you in the project folder.
The Grunt.js task uses the built in web server in PHP 5.4 to host the docs on your local machine. This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally.
To use the optional Grunt command you will need:
- Node.js
- npm
- Grunt.js
- PHP 5.4 or greater (This is because of the built-in web server packaged in 5.4)
This project contains a package.json file, so once you have the requirements installed, you can simply run a npm install and then grunt in the projects folder to start the local web server. By default the server will run at: http://localhost:8085
Running on IIS
If you have set up a local or remote IIS web site, you may need a web.config with:
- A rewrite configuration, for handling clean urls.
- A mime type handler for less files, if using a custom theme.
Clean URLs
The web.config needs an entry for <rewrite> under <system.webServer>:
<configuration>
<system.webServer>
<rewrite>
<rules>
<rule name="Main Rule" stopProcessing="true">
<match url=".*" />
<conditions logicalGrouping="MatchAll">
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
</conditions>
<action type="Rewrite" url="index.php" appendQueryString="false" />
</rule>
</rules>
</rewrite>
</system.webServer>
</configuration>
To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as URL Rewriter.
Less Mime Type
The web.config needs a new <mimeMap> entry, under <staticContent> in <system.webServer>:
<staticContent>
<mimeMap fileExtension=".less" mimeType="text/css" />
</staticContent>
You will only need the mime map entry if you are using a custom theme and receive 404s for .less files.
If you have a global mime map entry for .less files set for the server, you will receive an internal server (500) error for having duplicate mime map entries.
Support
If you need help using Daux.io, or have found a bug, please create an issue on the GitHub repo.