1 regel
83 KiB
JSON
1 regel
83 KiB
JSON
|
{"pages":[{"title":"DAUX.IO","text":"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. Features For Authors Auto Generated Navigation \/ Page sorting Internal documentation links CommonMark compliant Auto created homepage\/landing page Multiple Output Formats Multiple Languages Support No Build Step Static Output Generation Table of Contents For Developers Auto Syntax Highlighting Extend Daux.io with Processors Full access to the internal API to create new pages programatically Work with pages metadata For Marketing 100% Mobile Responsive 4 Built-In Themes or roll your own Functional, Flat Design Style Optional code float layout Shareable\/Linkable SEO Friendly URLs Supports Google Analytics and Piwik Analytics Installation and usage If you have PHP and Composer installed composer global require daux\/daux.io # Next to your `docs` folder, run daux generate Or if you wish to use Docker # Next to your `docs` folder, run docker run --rm -it -w \/build -v "$PWD":\/build daux\/daux.io daux generate","tags":"","url":"index.html"},{"title":"Getting Started","text":"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. Table of Contents Features For Authors For Developers For Marketing Demos Getting Started Install PHP and Composer Docker Writing pages See your pages Serving files Export to other formats Configuration PHP Requirements Extensions Known Issues Support Features For Authors Auto Generated Navigation \/ Page sorting Internal documentation links CommonMark compliant Auto created homepage\/landing page Multiple Output Formats Multiple Languages Support No Build Step Static Output Generation Table of Contents For Developers Auto Syntax Highlighting Extend Daux.io with Processors Full access to the internal API to create new pages programatically Work with pages metadata For Marketing 100% Mobile Responsive 4 Built-In Themes or roll your own Functional, Flat Design Style Optional code float layout Shareable\/Linkable SEO Friendly URLs Supports Google Analytics and Piwik Analytics Demos This is a list of sites using Daux.io: Daux.io DoctrineWatcher jDrupal DrupalGap Invade & Annex 3 - An Arma 3 Co-operative Mission Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation ICADMIN: An admin panel powered by CodeIgniter. Do you use Daux.io? Send us a pull request or open an issue and I will add you to the list. Getting Started Install PHP and Composer If you have PHP and Composer installed, you can install the dependency composer global require daux\/daux.io # Next to your `docs` folder, run daux generate You can then use the daux command line to generate your documentation. If the command isn't found, ensure your $PATH contains ~\/.composer\/vendor\/bin Docker Or if you wish to use Docker, the start of the command will be : docker run --rm -it -w \/build -v "$PWD":\/build daux\/daux.io daux Any parameter valid in the PHP version is valid in the Docker version Writing pages Creating new pages is very easy: Create a markdown file (*.md or *.markdown) Start writing 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. 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 See your pages Now you can see your pages. you have two options for that : serve them dire
|