197 lines
7.3 KiB
HTML
197 lines
7.3 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en">
|
|
<head>
|
|
<title>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 homepage">
|
|
|
|
|
|
<div class="Navbar NoPrint">
|
|
<div class="Container">
|
|
<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>
|
|
</div>
|
|
|
|
<div class="Homepage">
|
|
<div class="HomepageTitle Container">
|
|
<h2>The Easiest Way To Document Your Project</h2> </div>
|
|
|
|
<div class="HomepageImage Container">
|
|
<img class="homepage-image img-responsive" src="app.png" alt="DAUX.IO"> </div>
|
|
|
|
<div class="HomepageButtons">
|
|
<div class="Container">
|
|
<a href="https://github.com/dauxio/daux.io" class="Button Button--secondary Button--hero">View On GitHub</a><a href="Getting_Started.html" class="Button Button--primary Button--hero">View Documentation</a> </div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="HomepageContent">
|
|
<div class="Container">
|
|
<div class="Container--inner">
|
|
<div class="doc_content s-content">
|
|
<p class="HeroText">
|
|
<strong>Daux.io</strong> 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.
|
|
</p>
|
|
<hr />
|
|
<h3 id="page_Features">Features</h3>
|
|
<hr />
|
|
<div class="Row">
|
|
<div class="Row__third">
|
|
<h4 id="page_For-Authors">For Authors</h4>
|
|
<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>
|
|
</div>
|
|
<div class="Row__third">
|
|
<h4 id="page_For-Developers">For Developers</h4>
|
|
<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>
|
|
</div>
|
|
<div class="Row__third">
|
|
<h4 id="page_For-Marketing">For Marketing</h4>
|
|
<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>
|
|
</div>
|
|
</div>
|
|
<hr />
|
|
<h3 id="page_Installation-and-usage">Installation and usage</h3>
|
|
<p>If you have <strong>PHP</strong> and Composer installed</p>
|
|
<pre><code class="language-bash">composer global require daux/daux.io
|
|
|
|
# Next to your `docs` folder, run
|
|
daux generate
|
|
</code></pre>
|
|
<p>Or if you wish to use <strong>Docker</strong></p>
|
|
<pre><code class="language-bash"># Next to your `docs` folder, run
|
|
docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate
|
|
</code></pre>
|
|
<hr />
|
|
<!-- Google Code -->
|
|
<script type="text/javascript">
|
|
var google_conversion_id = 983836026;
|
|
var google_custom_params = window.google_tag_params;
|
|
var google_remarketing_only = true;
|
|
</script>
|
|
<script type="text/javascript" src="//www.googleadservices.com/pagead/conversion.js">
|
|
</script>
|
|
<noscript>
|
|
<div style="display:inline;">
|
|
<img height="1" width="1" style="border-style:none;" alt="" src="//googleads.g.doubleclick.net/pagead/viewthroughconversion/983836026/?value=0&guid=ON&script=0"/>
|
|
</div>
|
|
</noscript>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="HomepageFooter">
|
|
<div class="Container">
|
|
<div class="Container--inner">
|
|
<ul class="HomepageFooter__links">
|
|
<li><a href="https://github.com/dauxio/daux.io/archive/master.zip" target="_blank">Download</a></li><li><a href="https://github.com/dauxio/daux.io" target="_blank">GitHub Repo</a></li><li><a href="https://github.com/dauxio/daux.io/issues" target="_blank">Help/Support/Bugs</a></li> </ul>
|
|
|
|
<div class="HomepageFooter__twitter">
|
|
<div class="Twitter">
|
|
<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>
|
|
</div>
|
|
</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>
|