357 lines
17 KiB
HTML
357 lines
17 KiB
HTML
<!DOCTYPE html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<title>Getting Started - DAUX.IO</title>
|
||
<meta name="description" content="The Easiest Way To Document Your Project">
|
||
<meta name="author" content="Stéphane Goetz">
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
||
<link rel="icon" href="themes/daux/img/favicon-blue.png" type="image/x-icon">
|
||
|
||
<!-- Mobile -->
|
||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<!-- Font -->
|
||
|
||
<!-- CSS -->
|
||
<link href='themes/daux/css/theme-blue.min.css' rel='stylesheet' type='text/css'>
|
||
<!-- Tipue Search -->
|
||
<link href="tipuesearch/tipuesearch.css" rel="stylesheet">
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="themes/daux/js/html5shiv-3.7.3.min.js"></script>
|
||
<![endif]-->
|
||
</head>
|
||
<body class="with-float ">
|
||
<div class="Columns content">
|
||
<aside class="Columns__left Collapsible">
|
||
<button type="button" class="Button Collapsible__trigger">
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
</button>
|
||
|
||
<a class="Brand" href="index.html">DAUX.IO</a>
|
||
|
||
<div class="Search">
|
||
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
|
||
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
|
||
</svg>
|
||
<input type="search" id="tipue_search_input" class="Search__field" placeholder="Search..." autocomplete="on"
|
||
results=25 autosave=text_search>
|
||
</div>
|
||
|
||
<div class="Collapsible__content">
|
||
<!-- Navigation -->
|
||
<ul class='Nav'><li class='Nav__item Nav__item--active'><a href="Getting_Started.html">Getting Started</a></li><li class='Nav__item has-children'><a href="Features/Auto_Syntax_Highlight.html" class="folder"><i class="Nav__arrow"> </i>Features</a><ul class='Nav'><li class='Nav__item '><a href="Features/Auto_Syntax_Highlight.html">Auto Syntax Highlight</a></li><li class='Nav__item '><a href="Features/CommonMark_compliant.html">CommonMark compliant</a></li><li class='Nav__item '><a href="Features/Edit_on_GitHub_links.html">Edit on GitHub links</a></li><li class='Nav__item '><a href="Features/Front_Matter.html">Front Matter</a></li><li class='Nav__item '><a href="Features/Internal_links.html">Internal links</a></li><li class='Nav__item '><a href="Features/Landing_page.html">Landing page</a></li><li class='Nav__item '><a href="Features/Live_mode.html">Live mode</a></li><li class='Nav__item '><a href="Features/Multilanguage.html">Multilanguage</a></li><li class='Nav__item '><a href="Features/Multiple_Output_Formats.html">Multiple Output Formats</a></li><li class='Nav__item '><a href="Features/Navigation_and_Sorting.html">Navigation and Sorting</a></li><li class='Nav__item '><a href="Features/Search.html">Search</a></li><li class='Nav__item '><a href="Features/Static_Site_Generation.html">Static Site Generation</a></li><li class='Nav__item '><a href="Features/Table_of_contents.html">Table of contents</a></li></ul></li><li class='Nav__item has-children'><a href="Examples/index.html" class="folder"><i class="Nav__arrow"> </i>Examples</a><ul class='Nav'><li class='Nav__item '><a href="Examples/Code_Highlighting.html">Code Highlighting</a></li><li class='Nav__item '><a href="Examples/Hello_World.html">Hello World</a></li><li class='Nav__item '><a href="Examples/Hello_World_de.html">Hallo Welt</a></li><li class='Nav__item '><a href="Examples/привет_мир.html">привет мир</a></li><li class='Nav__item '><a href="Examples/你好世界.html">你好世界</a></li></ul></li><li class='Nav__item has-children'><a href="Configuration/index.html" class="folder"><i class="Nav__arrow"> </i>Configuration</a><ul class='Nav'><li class='Nav__item '><a href="Configuration/Confluence_upload.html">Confluence upload</a></li><li class='Nav__item '><a href="Configuration/Html_export.html">Html export</a></li></ul></li><li class='Nav__item has-children'><a href="For_Developers/Creating_a_Processor.html" class="folder"><i class="Nav__arrow"> </i>For Developers</a><ul class='Nav'><li class='Nav__item '><a href="For_Developers/Creating_a_Processor.html">Creating a Processor</a></li><li class='Nav__item '><a href="For_Developers/Creating_a_Theme.html">Creating a Theme</a></li></ul></li></ul>
|
||
|
||
<div class="Links">
|
||
<hr/>
|
||
<a href="https://github.com/dauxio/daux.io/archive/master.zip" target="_blank">Download</a>
|
||
<br />
|
||
<a href="https://github.com/dauxio/daux.io" target="_blank">GitHub Repo</a>
|
||
<br />
|
||
<a href="https://github.com/dauxio/daux.io/issues" target="_blank">Help/Support/Bugs</a>
|
||
<br />
|
||
</div>
|
||
|
||
<div class="CodeToggler">
|
||
<hr/>
|
||
<span class="CodeToggler__text">Code blocks</span>
|
||
<div class="ButtonGroup" role="group">
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--hide">No</button>
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--below">Below</button>
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--float">Inline</button>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="Twitter">
|
||
<hr/>
|
||
<iframe allowtransparency="true" frameborder="0" scrolling="no" style="width:162px; height:20px;" src="https://platform.twitter.com/widgets/follow_button.html?screen_name=onigoetz&show_count=false"></iframe>
|
||
<br />
|
||
<br />
|
||
</div>
|
||
|
||
<div class="PoweredBy">
|
||
<hr/>
|
||
Powered by Daux.io </div>
|
||
</div>
|
||
</aside>
|
||
<div class="Columns__right Columns__right--float">
|
||
<div class="Columns__right__content">
|
||
<div class="doc_content">
|
||
<article class="Page">
|
||
|
||
<div class="Page__header">
|
||
<h1><a href="Getting_Started.html">Getting Started</a></h1>
|
||
<span class="ModifiedDate">
|
||
Thursday, June 7, 2018 11:42 AM </span>
|
||
<span class="EditOn">
|
||
<a href="https://github.com/dauxio/daux.io/blob/master/docs/00_Getting_Started.md" target="_blank">
|
||
Edit on GitHub </a>
|
||
</span>
|
||
</div>
|
||
|
||
<div class="s-content">
|
||
<p><strong>Daux.io</strong> 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.</p>
|
||
<div class="TableOfContentsContainer">
|
||
<h4 class="TableOfContentsContainer__title">Table of Contents</h4>
|
||
<div class="TableOfContentsContainer__content">
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Features">Features</a></p>
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_For-Authors">For Authors</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_For-Developers">For Developers</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_For-Marketing">For Marketing</a></p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Demos">Demos</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Getting-Started">Getting Started</a></p>
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Install">Install</a></p>
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_PHP-and-Composer">PHP and Composer</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Docker">Docker</a></p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Writing-pages">Writing pages</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_See-your-pages">See your pages</a></p>
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Serving-files">Serving files</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Export-to-other-formats">Export to other formats</a></p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Configuration">Configuration</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_PHP-Requirements">PHP Requirements</a></p>
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Extensions">Extensions</a></p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Known-Issues">Known Issues</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Support">Support</a></p>
|
||
</li>
|
||
</ul> </div>
|
||
</div>
|
||
<h2 id="page_Features">Features</h2>
|
||
<h3 id="page_For-Authors">For Authors</h3>
|
||
<ul>
|
||
<li>
|
||
<a href="Features/Navigation_and_Sorting.html">Auto Generated Navigation / Page sorting</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Internal_links.html">Internal documentation links</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/CommonMark_compliant.html">CommonMark compliant</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Landing_page.html">Auto created homepage/landing page</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Multiple_Output_Formats.html">Multiple Output Formats</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Multilanguage.html">Multiple Languages Support</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Live_mode.html">No Build Step</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Static_Site_Generation.html">Static Output Generation</a>
|
||
</li>
|
||
<li>
|
||
<a href="Features/Table_of_contents.html">Table of Contents</a>
|
||
</li>
|
||
</ul>
|
||
<h3 id="page_For-Developers">For Developers</h3>
|
||
<ul>
|
||
<li>
|
||
<a href="Features/Auto_Syntax_Highlight.html">Auto Syntax Highlighting</a>
|
||
</li>
|
||
<li>
|
||
<a href="For_Developers/Creating_a_Processor.html">Extend Daux.io with Processors</a>
|
||
</li>
|
||
<li>Full access to the internal API to create new pages programatically</li>
|
||
<li>Work with pages metadata</li>
|
||
</ul>
|
||
<h3 id="page_For-Marketing">For Marketing</h3>
|
||
<ul>
|
||
<li>100% Mobile Responsive</li>
|
||
<li>4 Built-In Themes or roll your own</li>
|
||
<li>Functional, Flat Design Style</li>
|
||
<li>Optional code float layout</li>
|
||
<li>Shareable/Linkable SEO Friendly URLs</li>
|
||
<li>Supports Google Analytics and Piwik Analytics</li>
|
||
</ul>
|
||
<h2 id="page_Demos">Demos</h2>
|
||
<p>This is a list of sites using Daux.io:</p>
|
||
<ul>
|
||
<li>
|
||
<a href="https://dauxio.github.io/" class="Link--external">Daux.io</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://dsentker.github.io/WatcherDocumentation/" class="Link--external">DoctrineWatcher</a>
|
||
</li>
|
||
<li>
|
||
<a href="http://jdrupal.easystreet3.com/8/docs/" class="Link--external">jDrupal</a>
|
||
</li>
|
||
<li>
|
||
<a href="http://docs.drupalgap.org/8/" class="Link--external">DrupalGap</a>
|
||
</li>
|
||
<li>
|
||
<a href="http://ia3.ahoyworld.co.uk/" class="Link--external">Invade & Annex 3 - An Arma 3 Co-operative Mission</a>
|
||
</li>
|
||
<li>
|
||
<a href="http://mun.ee" class="Link--external">Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation</a>
|
||
</li>
|
||
<li>
|
||
<a href="http://istocode.com/shared/ic-admin/" class="Link--external">ICADMIN: An admin panel powered by CodeIgniter.</a>
|
||
</li>
|
||
</ul>
|
||
<p>Do you use Daux.io? Send us a pull request or open an <a href="https://github.com/dauxio/daux.io/issues" class="Link--external">issue</a> and I will add you to the list.</p>
|
||
<h2 id="page_Getting-Started">Getting Started</h2>
|
||
<h3 id="page_Install">Install</h3>
|
||
<h4 id="page_PHP-and-Composer">PHP and Composer</h4>
|
||
<p>If you have PHP and Composer installed, you can install the dependency</p>
|
||
<pre><code class="language-bash">composer global require daux/daux.io
|
||
|
||
# Next to your `docs` folder, run
|
||
daux generate
|
||
</code></pre>
|
||
<p>You can then use the <code>daux</code> command line to generate your documentation.</p>
|
||
<p>If the command isn't found, ensure your <code>$PATH</code> contains <code>~/.composer/vendor/bin</code></p>
|
||
<h4 id="page_Docker">Docker</h4>
|
||
<p>Or if you wish to use Docker, the start of the command will be :</p>
|
||
<pre><code class="language-bash">docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux
|
||
</code></pre>
|
||
<p>Any parameter valid in the PHP version is valid in the Docker version</p>
|
||
<h3 id="page_Writing-pages">Writing pages</h3>
|
||
<p>Creating new pages is very easy:</p>
|
||
<ol>
|
||
<li>Create a markdown file (<code>*.md</code> or <code>*.markdown</code>)</li>
|
||
<li>Start writing</li>
|
||
</ol>
|
||
<p>By default, the generator will look for folders in the <code>docs</code> folder.
|
||
Add your folders inside the <code>docs</code> folder. This project contains some example folders and files to get you started.</p>
|
||
<p>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.</p>
|
||
<p>You must use underscores instead of spaces. Here are some example file names and what they will be converted to:</p>
|
||
<p><strong>Good:</strong></p>
|
||
<ul>
|
||
<li>01_Getting_Started.md = Getting Started</li>
|
||
<li>API_Calls.md = API Calls</li>
|
||
<li>200_Something_Else-Cool.md = Something Else-Cool</li>
|
||
<li>_5_Ways_to_Be_Happy.md = 5 Ways To Be Happy</li>
|
||
</ul>
|
||
<p><strong>Bad:</strong></p>
|
||
<ul>
|
||
<li>File Name With Space.md = FAIL</li>
|
||
</ul>
|
||
<h3 id="page_See-your-pages">See your pages</h3>
|
||
<p>Now you can see your pages. you have two options for that : serve them directly, or generate to various formats.</p>
|
||
<p>We recommend the first one while you write your documentation, you get a much quicker feedback while writing.</p>
|
||
<h4 id="page_Serving-files">Serving files</h4>
|
||
<p>You can use PHP's embedded web server by running the following command in the root of your documentation</p>
|
||
<pre><code>./serve
|
||
</code></pre>
|
||
<p>Upload your files to an apache / nginx server and see your documentation</p>
|
||
<p><a href="Features/Live_mode.html">More informations here</a></p>
|
||
<h4 id="page_Export-to-other-formats">Export to other formats</h4>
|
||
<p>Daux.io is extendable and comes by default with three export formats:</p>
|
||
<ul>
|
||
<li>Export to HTML, same as the website, but can be hosted without PHP.</li>
|
||
<li>Export all documentation in a single HTML page</li>
|
||
<li>Upload to your Atlassian Confluence server.</li>
|
||
</ul>
|
||
<p><a href="Features/Multiple_Output_Formats.html">See a detailed feature comparison matrix</a></p>
|
||
<p>To export, run the <code>daux</code> command and your documentation will be generated in <code>static</code> (you can change the destination with the <code>--destination</code> option)</p>
|
||
<p><a href="Features/Static_Site_Generation.html">See here for all options</a></p>
|
||
<h2 id="page_Configuration">Configuration</h2>
|
||
<p>Now that you got the basics, you can also <a href="Configuration/index.html">see what you can configure</a></p>
|
||
<h2 id="page_PHP-Requirements">PHP Requirements</h2>
|
||
<p>Daux.io is compatible with PHP 5.6 and up.</p>
|
||
<p>The reason is because some dependencies we have do not support php 5.5 anymore.</p>
|
||
<h3 id="page_Extensions">Extensions</h3>
|
||
<p>PHP Needs the following extension to work : <code>php-mbstring</code> and <code>php-xml</code>.</p>
|
||
<p>If you encounter an error similar to <code>utf8_decode() not found</code> this means that you're missing the <code>php-xml</code> package. (We've seen it happen only on PHP 7)</p>
|
||
<h2 id="page_Known-Issues">Known Issues</h2>
|
||
<ul>
|
||
<li>
|
||
<strong>Windows UTF-8 files support</strong> Files with UTF-8 characters cannot be handled on windows with PHP5, PHP7 should work fine.</li>
|
||
</ul>
|
||
<h2 id="page_Support">Support</h2>
|
||
<p>If you need help using Daux.io, or have found a bug, please create an issue on the <a href="https://github.com/dauxio/daux.io/issues" target="_blank">GitHub repo</a>.</p>
|
||
</div>
|
||
|
||
<nav>
|
||
<ul class="Pager">
|
||
<li class=Pager--prev><a href="index.html">Previous</a></li> <li class=Pager--next><a href="Features/Auto_Syntax_Highlight.html">Next</a></li> </ul>
|
||
</nav>
|
||
</article>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-3551397-7', '');
|
||
ga('send', 'pageview');
|
||
</script>
|
||
|
||
<!-- JS -->
|
||
<script src="themes/daux/js/jquery-1.11.3.min.js"></script><script src="themes/daux/js/highlight.pack.js"></script><script src="themes/daux/js/daux.js"></script>
|
||
<!-- Tipue Search -->
|
||
<script type="text/javascript" src="tipuesearch/tipuesearch.js"></script>
|
||
|
||
<script>
|
||
window.onunload = function(){}; // force $(document).ready to be called on back/forward navigation in firefox
|
||
$(function() {
|
||
tipuesearch({
|
||
'base_url': ''
|
||
});
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html>
|