-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGetting_Started.html
435 lines (412 loc) · 21.5 KB
/
Getting_Started.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
<!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">
<!-- JS -->
<script>
window.base_url = "";
document.documentElement.classList.remove('no-js');
</script>
<!-- Font -->
<!-- CSS -->
<link href='themes/daux/css/theme-blue.min.css' rel='stylesheet' type='text/css'>
<link href='daux_libraries/search.css' rel='stylesheet' type='text/css'>
</head>
<body class="">
<div class="Columns content">
<aside class="Columns__left Collapsible">
<button type="button" class="Button Collapsible__trigger" aria-controls="sidebar_content" aria-expanded="false" aria-label="Toggle navigation">
<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>
<form role='search' action="/" method="get" class="Search" id="search_form">
<label for="search_input">
<span class='u-visuallyHidden'>Search</span>
</label>
<input
type="search"
id="search_input"
class="Search__field"
placeholder="Search..."
aria-label="Search..."
autocomplete="on"
results=25
autosave=text_search
>
<label>
<input type="submit" class='u-visuallyHidden' />
<span class='u-visuallyHidden'>Search...</span>
<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>
</label>
</form>
<div class="Collapsible__content" id="sidebar_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/Admonition.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Features</a><ul class='Nav'>
<li class='Nav__item '><a href="Features/Admonition.html">Admonition</a></li>
<li class='Nav__item '><a href="Features/Auto_Syntax_Highlight.html">Auto Syntax Highlight</a></li>
<li class='Nav__item '><a href="Features/Collapsible.html">Collapsible</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/Math_Diagrams_Flowcharts.html">Math, Diagrams and Flowcharts</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="Nav__item__link"><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/privet_mir.html">привет мир</a></li>
<li class='Nav__item '><a href="Examples/ni_hao_shi_jie.html">你好世界</a></li></ul></li>
<li class='Nav__item has-children'><a href="Configuration/index.html" class="Nav__item__link"><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="Nav__item__link"><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" target="_blank" rel="noopener noreferrer">GitHub Repository</a>
<br />
<a href="https://github.com/dauxio/daux.io/issues" target="_blank" rel="noopener noreferrer">Help/Support/Bugs</a>
<br />
<a href="https://packagist.org/packages/daux/daux.io" target="_blank" rel="noopener noreferrer">Packagist</a>
<br />
<a href="https://hub.docker.com/r/daux/daux.io" target="_blank" rel="noopener noreferrer">Docker Images</a>
<br />
</div>
<div class="CodeToggler">
<hr/>
<label class="Checkbox">Show Code Blocks <input type="checkbox" class="CodeToggler__button--main" checked="checked"/>
<div class="Checkbox__indicator"></div>
</label>
</div>
<div class="DarkModeToggler">
<hr/>
<label class="Checkbox">Dark Mode <input type="checkbox" class="ColorMode__button" />
<div class="Checkbox__indicator"></div>
</label>
</div>
<div class="Twitter">
<hr/>
<a class="Twitter__button" target="_blank" title="Follow @onigoetz on Twitter" href="https://twitter.com/intent/follow?screen_name=onigoetz" rel="noopener noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 72 72"><path fill="none" d="M0 0h72v72H0z"/><path class="icon" fill="#fff" d="M68.812 15.14c-2.348 1.04-4.87 1.744-7.52 2.06 2.704-1.62 4.78-4.186 5.757-7.243-2.53 1.5-5.33 2.592-8.314 3.176C56.35 10.59 52.948 9 49.182 9c-7.23 0-13.092 5.86-13.092 13.093 0 1.026.118 2.02.338 2.98C25.543 24.527 15.9 19.318 9.44 11.396c-1.125 1.936-1.77 4.184-1.77 6.58 0 4.543 2.312 8.552 5.824 10.9-2.146-.07-4.165-.658-5.93-1.64-.002.056-.002.11-.002.163 0 6.345 4.513 11.638 10.504 12.84-1.1.298-2.256.457-3.45.457-.845 0-1.666-.078-2.464-.23 1.667 5.2 6.5 8.985 12.23 9.09-4.482 3.51-10.13 5.605-16.26 5.605-1.055 0-2.096-.06-3.122-.184 5.794 3.717 12.676 5.882 20.067 5.882 24.083 0 37.25-19.95 37.25-37.25 0-.565-.013-1.133-.038-1.693 2.558-1.847 4.778-4.15 6.532-6.774z"/></svg>
<span class="Twitter__button__label">Follow @onigoetz</span>
</a>
<br />
</div>
<div class="PoweredBy">
<hr/>
Powered by Daux.io </div>
</div>
</aside>
<div class="Columns__right">
<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">
March 1, 2025 at 8:22 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>
<a href="#features">Features</a>
<ul>
<li>
<a href="#for-authors">For Authors</a>
</li>
<li>
<a href="#for-developers">For Developers</a>
</li>
<li>
<a href="#for-marketing">For Marketing</a>
</li>
</ul>
</li>
<li>
<a href="#demos">Demos</a>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li>
<a href="#install">Install</a>
<ul>
<li>
<a href="#php-and-composer">PHP and Composer</a>
</li>
<li>
<a href="#docker">Docker</a>
</li>
</ul>
</li>
<li>
<a href="#writing-pages">Writing pages</a>
</li>
<li>
<a href="#see-your-pages">See your pages</a>
<ul>
<li>
<a href="#serving-files">Serving files</a>
</li>
<li>
<a href="#export-to-other-formats">Export to other formats</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#configuration">Configuration</a>
<ul>
<li>
<a href="#server-configuration">Server Configuration</a>
<ul>
<li>
<a href="#apache">Apache</a>
</li>
<li>
<a href="#nginx">nginx</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#php-requirements">PHP Requirements</a>
<ul>
<li>
<a href="#extensions">Extensions</a>
</li>
</ul>
</li>
<li>
<a href="#support">Support</a>
</li>
</ul> </div>
</div>
<h2><a id="features" href="#features" class="Permalink" aria-hidden="true" title="Permalink">#</a>Features</h2>
<h3><a id="for-authors" href="#for-authors" class="Permalink" aria-hidden="true" title="Permalink">#</a>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><a id="for-developers" href="#for-developers" class="Permalink" aria-hidden="true" title="Permalink">#</a>For Developers</h3>
<ul>
<li>
<a href="Features/Auto_Syntax_Highlight.html">Auto Syntax Highlighting</a>
</li>
<li>
<a href="Features/Math_Diagrams_Flowcharts.html">Math, Diagrams and Flowcharts</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><a id="for-marketing" href="#for-marketing" class="Permalink" aria-hidden="true" title="Permalink">#</a>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>Shareable/Linkable SEO Friendly URLs</li>
<li>Supports Google Analytics and Piwik Analytics</li>
</ul>
<h2><a id="demos" href="#demos" class="Permalink" aria-hidden="true" title="Permalink">#</a>Demos</h2>
<p>This is a list of sites using Daux.io:</p>
<ul>
<li>With a custom theme:
<ul>
<li>
<a href="https://swissquote.github.io/crafty" class="Link--external" rel="noopener noreferrer">Crafty</a>
</li>
<li>
<a href="https://docs.pixolution.org" class="Link--external" rel="noopener noreferrer">Pixolution flow</a> * <a href="https://doc.soisy.it/" class="Link--external" rel="noopener noreferrer">Soisy</a>
</li>
<li>
<a href="https://vulkan-tutorial.com" class="Link--external" rel="noopener noreferrer">Vulkan Tutorial</a>
</li>
<li>
<a href="https://docs.3q.video/" class="Link--external" rel="noopener noreferrer">3Q</a>
</li>
</ul>
</li>
<li>With the default Theme
<ul>
<li>
<a href="https://daux.io/" class="Link--external" rel="noopener noreferrer">Daux.io</a>
_ <a href="https://dsentker.github.io/WatcherDocumentation/" class="Link--external" rel="noopener noreferrer">DoctrineWatcher</a>
_ <a href="http://docs.drupalgap.org/8/" class="Link--external" rel="noopener noreferrer">DrupalGap</a>
</li>
<li>
<a href="http://istocode.com/shared/ic-admin/" class="Link--external" rel="noopener noreferrer">ICADMIN: An admin panel powered by CodeIgniter.</a>
</li>
<li>
<a href="http://mun.ee" class="Link--external" rel="noopener noreferrer">Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation</a>
</li>
<li>
<a href="https://roysegall.github.io/nuntius-bot/" class="Link--external" rel="noopener noreferrer">Nuntius: A PHP framework for bots</a>
</li>
</ul>
</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" rel="noopener noreferrer">issue</a> and I will add you to the list.</p>
<h2><a id="getting-started" href="#getting-started" class="Permalink" aria-hidden="true" title="Permalink">#</a>Getting Started</h2>
<h3><a id="install" href="#install" class="Permalink" aria-hidden="true" title="Permalink">#</a>Install</h3>
<h4><a id="php-and-composer" href="#php-and-composer" class="Permalink" aria-hidden="true" title="Permalink">#</a>PHP and Composer</h4>
<p>If you have PHP and Composer installed, you can install the dependency</p>
<pre><code class="hljs bash">composer global require daux/daux.io
<span class="hljs-comment"># Next to your `docs` folder, run</span>
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> or <code>~/.config/composer/vendor/bin</code>.</p>
<h4><a id="docker" href="#docker" class="Permalink" aria-hidden="true" title="Permalink">#</a>Docker</h4>
<p>Or if you wish to use Docker, the start of the command will be :</p>
<pre><code class="hljs bash">docker run --rm -it -p 8085:8085 -w /build -v <span class="hljs-string">"<span class="hljs-variable">$PWD</span>"</span>:/build daux/daux.io daux
</code></pre>
<p>Any parameter valid in the PHP version is valid in the Docker version</p>
<h3><a id="writing-pages" href="#writing-pages" class="Permalink" aria-hidden="true" title="Permalink">#</a>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><a id="see-your-pages" href="#see-your-pages" class="Permalink" aria-hidden="true" title="Permalink">#</a>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><a id="serving-files" href="#serving-files" class="Permalink" aria-hidden="true" title="Permalink">#</a>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><a id="export-to-other-formats" href="#export-to-other-formats" class="Permalink" aria-hidden="true" title="Permalink">#</a>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><a id="configuration" href="#configuration" class="Permalink" aria-hidden="true" title="Permalink">#</a>Configuration</h2>
<p>Now that you got the basics, you can also <a href="Configuration/index.html">see what you can configure</a></p>
<h3><a id="server-configuration" href="#server-configuration" class="Permalink" aria-hidden="true" title="Permalink">#</a>Server Configuration</h3>
<p>We are using <code>.mjs</code> file types. Which not every web server properly understands and serves.</p>
<p>You might see an error like <code>Failed to load module script: Expected a JavaScript module script but the server responded with a MIME type of "application/octet-stream". Strict MIME type checking is enforced for module scripts per HTML spec.</code></p>
<h4><a id="apache" href="#apache" class="Permalink" aria-hidden="true" title="Permalink">#</a>Apache</h4>
<p>If you are using a version under 2.5.1 of Apache HTTPd.</p>
<p>Add the following line within <code>.htaccess</code>, vhost or server configuration.</p>
<pre><code>AddType application/javascript .mjs
</code></pre>
<h4><a id="nginx" href="#nginx" class="Permalink" aria-hidden="true" title="Permalink">#</a>nginx</h4>
<pre><code> include mime.types;
types {
application/javascript js mjs;
}
</code></pre>
<h2><a id="php-requirements" href="#php-requirements" class="Permalink" aria-hidden="true" title="Permalink">#</a>PHP Requirements</h2>
<p>Daux.io is compatible with the <a href="https://www.php.net/supported-versions.php" class="Link--external" rel="noopener noreferrer">officially supported</a> PHP versions; 8.1.0 and up.</p>
<h3><a id="extensions" href="#extensions" class="Permalink" aria-hidden="true" title="Permalink">#</a>Extensions</h3>
<p>Daux.io needs the following PHP extensions to work : <code>php-mbstring</code> and <code>php-xml</code>.</p>
<p>If you use non-english characters in your page names, it is recommended to install the <code>php-intl</code> extension as well.</p>
<h2><a id="support" href="#support" class="Permalink" aria-hidden="true" title="Permalink">#</a>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/Admonition.html">Next</a></li> </ul>
</nav>
</article>
</div>
</div>
</div>
</div>
<script async defer data-domain="daux.io" src="https://plausible.io/js/plausible.js"></script>
<!-- JS -->
<script src="themes/daux/js/main.mjs"></script>
<script>
window.searchLanguage = "";
window.searchTranslation = {"Search_one_result":"1 result","Search_results":"!count results","Search_no_results":"Nothing found","Search_common_words_ignored":"Common words are largely ignored","Search_too_short":"Search too short","Search_one_character_or_more":"Should be one character or more","Search_should_be_x_or_more":"Should be !min characters or more","Link_previous":"Previous","Link_next":"Next"};
</script>
<!-- Search -->
<script type="text/javascript" src="daux_libraries/search.min.js"></script>
<script>
window.search({'base_url': ''})
</script>
</body>
</html>