290 lines
15 KiB
HTML
290 lines
15 KiB
HTML
<!DOCTYPE html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<title>Configuration - 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 '><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 Nav__item--open 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="../Configuration/index.html">Configuration</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/05_Configuration/_index.md" target="_blank">
|
||
Edit on GitHub </a>
|
||
</span>
|
||
</div>
|
||
|
||
<div class="s-content">
|
||
<p>To customize the look and feel of your documentation, you can create a <code>config.json</code> file in the of the <code>/docs</code> folder. The <code>config.json</code> file is a JSON object that you can use to change some of the basic settings of the documentation.</p>
|
||
<p><strong>Table of contents</strong></p>
|
||
<div class="TableOfContentsContainer">
|
||
<h4 class="TableOfContentsContainer__title">Table of Contents</h4>
|
||
<div class="TableOfContentsContainer__content">
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Title">Title</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Tagline">Tagline</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Author">Author</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Image">Image</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Format">Format</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Ignore">Ignore</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Timezone">Timezone</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Multi-language">Multi-language</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Language">Language</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Processor">Processor</a></p>
|
||
</li>
|
||
</ul> </div>
|
||
</div>
|
||
<h3 id="page_Title">Title</h3>
|
||
<p>Change the title bar in the docs</p>
|
||
<pre><code class="language-json">{
|
||
"title": "Daux.io"
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Tagline">Tagline</h3>
|
||
<p>Change the tagline bar in the docs</p>
|
||
<pre><code class="language-json">{
|
||
"tagline": "The Easiest Way To Document Your Project"
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Author">Author</h3>
|
||
<p>Change the documentation's author</p>
|
||
<pre><code class="language-json">{
|
||
"author": "Stéphane Goetz"
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Image">Image</h3>
|
||
<p>An image to show on the landing page. A relative path from the documentation root.</p>
|
||
<pre><code class="language-json">{
|
||
"image": "image.png"
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Format">Format</h3>
|
||
<p>Change the output format. It is recommended you set only formats that support the live mode as this will also
|
||
be read by the integrated web server. And you set the other formats (like confluence) only by command line</p>
|
||
<pre><code class="language-json">{
|
||
"format": "html"
|
||
}
|
||
</code></pre>
|
||
<ul>
|
||
<li>
|
||
<strong>html</strong> with <a href="Html_export.html">its options</a>
|
||
</li>
|
||
<li>
|
||
<strong>confluence</strong> with <a href="Confluence_upload.html">its options</a>
|
||
</li>
|
||
</ul>
|
||
<p>Available formats are <strong>HTML</strong> and <strong>Confluence</strong></p>
|
||
<h3 id="page_Ignore">Ignore</h3>
|
||
<p>Set custom files and entire folders to ignore within your <code>/docs</code> folder. For files make sure to include the file extension in the name. For both files and folders, names are case-sensitive.</p>
|
||
<pre><code class="language-json">{
|
||
"ignore": {
|
||
"files": ["Work_In_Progress.md"],
|
||
"folders": ["99_Not_Ready"]
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Timezone">Timezone</h3>
|
||
<p>If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the <a href="http://php.net/manual/en/timezones.php" class="Link--external">PHP Manual</a>.</p>
|
||
<pre><code class="language-json">{
|
||
"timezone": "America/Los_Angeles"
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Multi-language">Multi-language</h3>
|
||
<p>Enables multi-language support which needs separate directories for each language in <code>docs/</code> folder.</p>
|
||
<pre><code class="language-json">{
|
||
"languages": {"en": "English", "de": "German"}
|
||
}
|
||
</code></pre>
|
||
<p>Directory structure:</p>
|
||
<pre><code>├── docs/
|
||
│ ├── _index.md
|
||
│ ├── en
|
||
│ │ ├── 00_Getting_Started.md
|
||
│ │ ├── 01_Examples
|
||
│ │ │ ├── 01_CommonMark_compliant.md
|
||
│ │ │ ├── 05_Code_Highlighting.md
|
||
│ │ ├── 05_More_Examples
|
||
│ │ │ ├── Hello_World.md
|
||
│ │ │ ├── 05_Code_Highlighting.md
|
||
│ ├── de
|
||
│ │ ├── 00_Getting_Started.md
|
||
│ │ ├── 01_Examples
|
||
│ │ │ ├── 01_CommonMark_compliant.md
|
||
│ │ │ ├── 05_Code_Highlighting.md
|
||
│ │ ├── 05_More_Examples
|
||
│ │ │ ├── Hello_World.md
|
||
│ │ │ ├── 05_Code_Highlighting.md
|
||
</code></pre>
|
||
<h3 id="page_Language">Language</h3>
|
||
<p>You can change the default language with the <code>language</code> option.</p>
|
||
<pre><code class="language-json">{
|
||
"language": "fr"
|
||
}
|
||
</code></pre>
|
||
<p>This will change the language of the text within Daux.io and also the <code><html lang></code> attribute.</p>
|
||
<p>You can override the translations with the <code>strings</code> option.
|
||
A string that isn't found will fall back to english.</p>
|
||
<pre><code class="language-json">{
|
||
"strings": {
|
||
"fr": {
|
||
"CodeBlocks_title": "Afficher le code",
|
||
"CodeBlocks_hide": "Non",
|
||
"CodeBlocks_below": "En Dessous",
|
||
"CodeBlocks_inline": "A côté",
|
||
"CodeBlocks_show": "Afficher le code",
|
||
"Search_placeholder": "Rechercher...",
|
||
"Link_previous": "Précédent",
|
||
"Link_next": "Suivant",
|
||
"Edit_on": "Editer sur :name:",
|
||
"View_on_github": "Voir sur GitHub",
|
||
"View_documentation": "Voir la Documentation"
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3 id="page_Processor">Processor</h3>
|
||
<p>You can set the processor in the documentation or as an option to the command line. If you need it when running the server, you should add it to the configuration.</p>
|
||
<p>More information on how to create a Processor can be found <a href="../For_Developers/Creating_a_Processor.html">here</a>.</p>
|
||
<pre><code class="language-json">{
|
||
"processor": "MyProcessor"
|
||
}
|
||
</code></pre>
|
||
</div>
|
||
|
||
<nav>
|
||
<ul class="Pager">
|
||
<li class=Pager--prev><a href="../Examples/你好世界.html">Previous</a></li> <li class=Pager--next><a href="../Configuration/Confluence_upload.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>
|