224 lines
13 KiB
HTML
224 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html class="no-js" lang="en">
|
|||
|
|
<head>
|
|||
|
|
<title>Live mode - 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 Nav__item--open 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 Nav__item--active'><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="../Features/Auto_Syntax_Highlight.html">Features</a> <svg class="Page__header--separator" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 477.175 477.175"><path d="M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z"/></svg> <a href="../Features/Live_mode.html">Live mode</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/01_Features/Live_mode.md" target="_blank">
|
|||
|
|
Edit on GitHub </a>
|
|||
|
|
</span>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="s-content">
|
|||
|
|
<p>Keep in mind, this mode can be used for production, but it is not recommended.</p>
|
|||
|
|
<p>The whole directory must be scanned on each request. This might not make a big impact on small documentations but can be a bottleneck on bigger ones.</p>
|
|||
|
|
<h2 id="page_Running-Locally">Running Locally</h2>
|
|||
|
|
<p>There are several ways to run the docs locally. You can use something like <a href="http://www.mamp.info/en/index.html" target="_blank">MAMP</a> or <a href="http://www.wampserver.com/en/" target="_blank">WAMP</a>.</p>
|
|||
|
|
<p>The easiest is to use PHP's built-in server.</p>
|
|||
|
|
<p>For that i've included a short command, run <code>daux serve</code> in the projects folder to start the local web server. By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a></p>
|
|||
|
|
<h2 id="page_Running-Remotely">Running Remotely</h2>
|
|||
|
|
<h3 id="page_Clean-URLs-configuration">Clean URLs configuration</h3>
|
|||
|
|
<p>Daux provides native support for Clean URLs provided the webserver has its URL Rewrite module enabled.
|
|||
|
|
To enable the same, set the toggle in the <code>config.json</code> file in the <code>/docs</code> folder.</p>
|
|||
|
|
<pre><code class="language-json">{
|
|||
|
|
"live": {
|
|||
|
|
"clean_urls": true
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="page_Apache">Apache</h3>
|
|||
|
|
<p>Copy the files from the repo to a web server that can run PHP 5.6 or greater.</p>
|
|||
|
|
<p>There is an included <code>.htaccess</code> for Apache web server.</p>
|
|||
|
|
<h3 id="page_Nginx">Nginx</h3>
|
|||
|
|
<p>Daux.io works perfectly fine on Nginx too, just drop this configuration in your <code>nginx.conf</code></p>
|
|||
|
|
<pre><code>server {
|
|||
|
|
listen 8085;
|
|||
|
|
server_name localhost;
|
|||
|
|
|
|||
|
|
index index.html index.php;
|
|||
|
|
charset utf-8;
|
|||
|
|
|
|||
|
|
root /var/www/docs;
|
|||
|
|
|
|||
|
|
location / {
|
|||
|
|
if (!-e $request_filename){
|
|||
|
|
rewrite ^(.*)$ /index.php$1;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
location ~ \.php {
|
|||
|
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
|||
|
|
|
|||
|
|
fastcgi_pass unix:/var/run/php5-fpm.sock;
|
|||
|
|
#fastcgi_pass 127.0.0.1:9000;
|
|||
|
|
fastcgi_index index.php;
|
|||
|
|
|
|||
|
|
include fastcgi_params;
|
|||
|
|
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
|||
|
|
fastcgi_param PATH_INFO $fastcgi_path_info;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="page_IIS">IIS</h2>
|
|||
|
|
<p>If you have set up a local or remote IIS web site, you may need a <code>web.config</code> with:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>A rewrite configuration, for handling clean urls.</li>
|
|||
|
|
<li>A mime type handler for less files, if using a custom theme.</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="page_Clean-URLs">Clean URLs</h3>
|
|||
|
|
<p>The <code>web.config</code> needs an entry for <code><rewrite></code> under <code><system.webServer></code>:</p>
|
|||
|
|
<pre><code class="language-xml"><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>
|
|||
|
|
</code></pre>
|
|||
|
|
<p>To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as <a href="http://urlrewriter.net/" class="Link--external">URL Rewriter</a>.</p>
|
|||
|
|
<h2 id="page_Docker">Docker</h2>
|
|||
|
|
<p>This is not meant for production use, but you can bundle your documentation in Daux's docker container</p>
|
|||
|
|
<pre><code>FROM daux/daux.io
|
|||
|
|
|
|||
|
|
WORKDIR /daux/
|
|||
|
|
COPY docs/ /daux/docs/
|
|||
|
|
|
|||
|
|
EXPOSE 80
|
|||
|
|
ENTRYPOINT [ "php", "-S", "0.0.0.0:80", "index.php" ]
|
|||
|
|
</code></pre>
|
|||
|
|
<p>When you add this to a <code>Dockerfile</code> and run <code>docker build --name my-daux-doc .</code> and then <code>docker --rm run -p 8000:80 my-daux-doc</code></p>
|
|||
|
|
<p>You can access your documentation at <code>localhost:8000</code></p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<nav>
|
|||
|
|
<ul class="Pager">
|
|||
|
|
<li class=Pager--prev><a href="../Features/Landing_page.html">Previous</a></li> <li class=Pager--next><a href="../Features/Multilanguage.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>
|