Compare commits
No commits in common. "master" and "gh-pages" have entirely different histories.
|
|
@ -1,2 +0,0 @@
|
|||
vendor
|
||||
node_modules
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
end_of_line = lf
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.{rb,sh,md,yaml},package.json]
|
||||
indent_size = 2
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
|
@ -1 +0,0 @@
|
|||
* text=auto
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
name: CI
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
max-parallel: 15
|
||||
matrix:
|
||||
# TODO : enable tests on windows
|
||||
operating-system: [ubuntu-latest, macOS-latest]
|
||||
php-versions: ['7.2', '7.3', '7.4']
|
||||
exclude:
|
||||
- operating-system: macos-latest
|
||||
php-versions: 7.4
|
||||
|
||||
name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
|
||||
runs-on: ${{ matrix.operating-system }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@master
|
||||
with:
|
||||
php-version: ${{ matrix.php-versions }}
|
||||
extension-csv: mbstring, dom, intl
|
||||
|
||||
- name: Validate composer.json and composer.lock
|
||||
run: composer validate
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress --no-suggest
|
||||
|
||||
- name: Install tools
|
||||
run: ./scripts/install_tools.sh
|
||||
|
||||
- name: Run test suite
|
||||
run: composer run-script test
|
||||
|
||||
sonarcloud:
|
||||
name: "SonarCloud"
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name != 'pull_request'
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@master
|
||||
with:
|
||||
php-version: 7.4
|
||||
extension-csv: mbstring, dom, intl
|
||||
coverage: pcov
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress --no-suggest
|
||||
|
||||
- name: Install tools
|
||||
run: ./scripts/install_tools.sh
|
||||
|
||||
- name: Run test suite
|
||||
run: composer run-script test -- --coverage-clover=coverage.clover --log-junit=test-report.xml
|
||||
|
||||
- name: Fix reports
|
||||
run: scripts/fix_reports.sh
|
||||
|
||||
- name: SonarCloud Scan
|
||||
uses: SonarSource/sonarcloud-github-action@v1.1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
|
||||
documentation:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.repository == 'dauxio/daux.io' && github.event_name != 'pull_request' && github.ref == 'refs/heads/master'
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress --no-suggest
|
||||
- name: Generate documentation
|
||||
run: bin/daux generate --value html.plausible_domain=daux.io
|
||||
- uses: JamesIves/github-pages-deploy-action@2.0.3
|
||||
env:
|
||||
FOLDER: "static"
|
||||
BRANCH: gh-pages
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
node_modules
|
||||
.DS_Store
|
||||
.idea
|
||||
/sftp-config.json
|
||||
static
|
||||
|
||||
/vendor
|
||||
/build
|
||||
.phpunit.result.cache
|
||||
.php_cs.cache
|
||||
coverage.clover
|
||||
test-report.xml
|
||||
|
||||
/prettier.config.js
|
||||
/.eslintrc.js
|
||||
/stylelint.config.js
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
RewriteEngine On
|
||||
#RewriteBase /
|
||||
|
||||
RewriteCond %{REQUEST_FILENAME} !-f
|
||||
RewriteCond %{REQUEST_FILENAME} !-d
|
||||
RewriteRule . index.php [L,QSA]
|
||||
28
.php_cs
28
.php_cs
|
|
@ -1,28 +0,0 @@
|
|||
<?php
|
||||
|
||||
$finder = PhpCsFixer\Finder::create()
|
||||
->exclude('vendor')
|
||||
->exclude('templates')
|
||||
->in(__DIR__)
|
||||
;
|
||||
|
||||
return PhpCsFixer\Config::create()
|
||||
->setRules([
|
||||
'@PSR2' => true,
|
||||
'@PHP70Migration' => true,
|
||||
'@PHP71Migration' => true,
|
||||
'@PhpCsFixer' => true,
|
||||
'explicit_string_variable' => false,
|
||||
'single_blank_line_before_namespace' => false,
|
||||
'no_short_echo_tag' => false,
|
||||
'blank_line_after_opening_tag' => false,
|
||||
'yoda_style' => false,
|
||||
'concat_space' => ['spacing' => 'one'],
|
||||
'php_unit_internal_class' => false,
|
||||
'php_unit_test_class_requires_covers' => false,
|
||||
'phpdoc_align' => false,
|
||||
'multiline_whitespace_before_semicolons' => false,
|
||||
'ordered_class_elements' => ['use_trait', 'constant_public', 'constant_protected', 'constant_private', 'property_public', 'property_protected', 'property_private', 'construct', 'method']
|
||||
])
|
||||
->setFinder($finder)
|
||||
;
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at stephane.goetz@onigoetz.ch. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
|
|
@ -0,0 +1,219 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Confluence upload - 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 Nav__item--active'><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> <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="../Configuration/Confluence_upload.html">Confluence upload</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/Confluence_upload.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<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_Configuring-the-connection">Configuring the connection</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Where-to-upload">Where to upload</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Prefix">Prefix</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Update-threshold">Update threshold</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Delete-old-pages">Delete old pages</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Information-message">Information message</a></p>
|
||||
</li>
|
||||
</ul> </div>
|
||||
</div>
|
||||
<h2 id="page_Configuring-the-connection">Configuring the connection</h2>
|
||||
<p>The connection requires three parameters <code>base_url</code>, <code>user</code> and <code>pass</code>. While <code>user</code> and <code>pass</code> don't really need an explanation, for <code>base_url</code> you need to set the path to the server without <code>rest/api</code>, this will be added automatically.</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": {
|
||||
"base_url": "http://my_confluence_server.com/",
|
||||
"user" : "my_username",
|
||||
"pass" : "my_password"
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Where-to-upload">Where to upload</h2>
|
||||
<p>Now that the connection is defined, you need to tell it where you want your documentation to be uploaded.</p>
|
||||
<p>For that you need a <code>space_id</code> (name that appears at the beginning of the urls) and an <code>ancestor_id</code>; the id of the page that will be the parent of the documentation's homepage.</p>
|
||||
<p>You can obtain the <code>ancestor_id</code> id by editing the page you want to define as a parent: the ID is at the end of the URL</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": {
|
||||
"space_id": "my_space",
|
||||
"ancestor_id": 50370632
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>You can also provide a <code>root_id</code> instead of an <code>ancestor_id</code> in this case, you specify the id as the homepage of your documentation.</p>
|
||||
<p>You can use that when you're uploading your documentation to the root of a Confluence Space or if your page already exists.</p>
|
||||
<h2 id="page_Prefix">Prefix</h2>
|
||||
<p>Because confluence can't have two pages with the same name in a space, I recommend you define a prefix for your pages.</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": { "prefix": "DAUX -" }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Update-threshold">Update threshold</h2>
|
||||
<p>To make the upload quicker, we try to determine if a page changed or not, first with a strict comparison and if it's not completely identical, we compute the difference.</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": { "update_threshold": 1 }
|
||||
}
|
||||
</code></pre>
|
||||
<p>If you set <code>update_threshold</code> to 1, it will upload only if the page has more than 1% difference with the previous one.</p>
|
||||
<p>By default the threshold is 2%.</p>
|
||||
<p>Setting the value to <code>0</code> disables the feature altogether.</p>
|
||||
<h2 id="page_Delete-old-pages">Delete old pages</h2>
|
||||
<p>When a page is renamed, there is no way to tell it was renamed, so when uploading to Confluence, the page will be uploaded and the old page will stay here.</p>
|
||||
<p>By default, it will inform you that some pages aren't needed anymore and you can delete them by hand.</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": { "delete": true }
|
||||
}
|
||||
</code></pre>
|
||||
<p>By setting <code>delete</code> to <code>true</code> (or running <code>daux</code> with the <code>--delete</code> flag) you tell the generator that it can safely delete the pages.</p>
|
||||
<h2 id="page_Information-message">Information message</h2>
|
||||
<p>When you create your page. there is no indication that the upload process will override the content of the pages.</p>
|
||||
<p>It happens sometimes that users edit the pages to add / fix an information.</p>
|
||||
<p>You can add a text in a "information" macro on top of the document by setting the following configuration :</p>
|
||||
<pre><code class="language-json">{
|
||||
"confluence": {
|
||||
"header": "These pages are updated automatically, your changes will be overriden."
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>It will look like this :</p>
|
||||
<p><img src="info_macro.png" alt="Info macro" /></p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Configuration/index.html">Previous</a></li> <li class=Pager--next><a href="../Configuration/Html_export.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>
|
||||
|
|
@ -0,0 +1,323 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Html export - 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 Nav__item--active'><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> <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="../Configuration/Html_export.html">Html export</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/Html_export.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<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_Analytics">Analytics</a></p>
|
||||
<ul class="TableOfContents">
|
||||
<li>
|
||||
<p><a href="#page_Google-Analytics">Google Analytics</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Piwik-Analytics">Piwik Analytics</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Automatic-Table-of-Contents">Automatic Table of Contents</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Buttons">Buttons</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Breadcrumb-titles">Breadcrumb titles</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Code-Floating">Code Floating</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Date-Modified">Date Modified</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_GitHub-Repo">GitHub Repo</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Inherit-Index">Inherit Index</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Jump-buttons">Jump buttons</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Landing-page">Landing page</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Links">Links</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Search">Search</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Themes">Themes</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Toggling-Code-Blocks">Toggling Code Blocks</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="#page_Twitter">Twitter</a></p>
|
||||
</li>
|
||||
</ul> </div>
|
||||
</div>
|
||||
<h2 id="page_Analytics">Analytics</h2>
|
||||
<h3 id="page_Google-Analytics">Google Analytics</h3>
|
||||
<p>This will embed the google analytics tracking code.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "google_analytics": "UA-XXXXXXXXX-XX" }
|
||||
}
|
||||
</code></pre>
|
||||
<h3 id="page_Piwik-Analytics">Piwik Analytics</h3>
|
||||
<p>This will embed the piwik tracking code.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "piwik_analytics": "my-url-for-piwik.com" }
|
||||
}
|
||||
</code></pre>
|
||||
<p>You can Also give a specific Piwik ID as well.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "piwik_analytics_id": "43" }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Automatic-Table-of-Contents">Automatic Table of Contents</h2>
|
||||
<p>You can add a table of contents on each page automatically, read about it <a href="../Features/Table_of_contents.html">here</a></p>
|
||||
<h2 id="page_Buttons">Buttons</h2>
|
||||
<p>You can add buttons to the landing page.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"buttons": {
|
||||
"My Website": "http://example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Breadcrumb-titles">Breadcrumb titles</h2>
|
||||
<p>Daux.io provides the option to present page titles as breadcrumb navigation.
|
||||
You can <em>optionally</em> specify the separator used for breadcrumbs.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"breadcrumbs": true,
|
||||
"breadcrumb_separator" : " > "
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Code-Floating">Code Floating</h2>
|
||||
<p>By default your code blocks will be floated to a column on the right side of your content.
|
||||
To disable this feature, set the <code>float</code> property to <code>false</code>.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "float": false }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Date-Modified">Date Modified</h2>
|
||||
<p>By default, daux.io will display the last modified time as reported by the system underneath the title for each document.
|
||||
To disable this, change the option in your config.json to <code>false</code>.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "date_modified": false }
|
||||
}
|
||||
</code></pre>
|
||||
<p>If you want to use the last modified time you can set the <a href="http://php.net/manual/function.date.php" class="Link--external">format</a> with the <code>date_modified_format</code> option.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"date_modified": true,
|
||||
"date_modified_format": "l, F j, Y g:i A"
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_GitHub-Repo">GitHub Repo</h2>
|
||||
<p>Add a 'Fork me on GitHub' ribbon.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "repo": "dauxio/daux.io" }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Inherit-Index">Inherit Index</h2>
|
||||
<p>This feature will instructs the navigation generator to seek the first available file to use when there is no index in a folder.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "inherit_index": true }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Jump-buttons">Jump buttons</h2>
|
||||
<p>You can have previous/next buttons on each page.
|
||||
They can be disabled by setting <code>jump_buttons</code> to <code>false</code>.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "jump_buttons": false }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Landing-page">Landing page</h2>
|
||||
<p>The automatic landing page can be disabled through the <code>auto_landing</code> option, read about it <a href="../Features/Landing_page.html">here</a></p>
|
||||
<h2 id="page_Links">Links</h2>
|
||||
<p>Include custom links in the sidebar.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"links": {
|
||||
"GitHub Repo": "https://github.com/dauxio/daux.io",
|
||||
"Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues",
|
||||
"Made by Todaymade": "http://todaymade.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Search">Search</h2>
|
||||
<p>Daux has an embedded search engine read all about it <a href="../Features/Search.html">here</a></p>
|
||||
<h2 id="page_Themes">Themes</h2>
|
||||
<p>We have 4 built-in Bootstrap themes. To use one of the themes, just set the <code>theme</code> option to one of the following:</p>
|
||||
<ul>
|
||||
<li>daux-blue</li>
|
||||
<li>daux-green</li>
|
||||
<li>daux-navy</li>
|
||||
<li>daux-red</li>
|
||||
</ul>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "theme": "daux-blue" }
|
||||
}
|
||||
</code></pre>
|
||||
<p>To use a custom theme, just copy over the theme folder into the <code>themes</code> directory and set its value in the <code>theme</code> param in <code>config.json</code></p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "theme": "new-theme" }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Toggling-Code-Blocks">Toggling Code Blocks</h2>
|
||||
<p>Some users might wish to hide the code blocks & view just the documentation.
|
||||
By setting the <code>toggle_code</code> property to <code>true</code>, you can offer a toggle button on the page.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "toggle_code": true }
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Twitter">Twitter</h2>
|
||||
<p>Include twitter follow buttons in the sidebar.</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": { "twitter": ["justin_walsh", "todaymade"] }
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Configuration/Confluence_upload.html">Previous</a></li> <li class=Pager--next><a href="../For_Developers/Creating_a_Processor.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>
|
||||
|
|
@ -0,0 +1,289 @@
|
|||
<!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>
|
||||
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
35
Dockerfile
35
Dockerfile
|
|
@ -1,35 +0,0 @@
|
|||
FROM composer:1.10.5 AS composer
|
||||
|
||||
FROM php:7-stretch
|
||||
|
||||
RUN apt-get update && apt-get install -y libicu-dev git unzip
|
||||
RUN docker-php-ext-configure intl \
|
||||
&& docker-php-ext-install intl
|
||||
|
||||
RUN mkdir /daux && mkdir /build
|
||||
|
||||
WORKDIR /daux
|
||||
|
||||
COPY --from=composer /usr/bin/composer /usr/bin/composer
|
||||
|
||||
# Copy files
|
||||
COPY composer.json /daux/composer.json
|
||||
COPY composer.lock /daux/composer.lock
|
||||
|
||||
RUN composer install --prefer-dist --no-ansi --no-dev --no-interaction --no-progress --no-scripts --optimize-autoloader
|
||||
|
||||
COPY bin/ /daux/bin/
|
||||
COPY libs/ /daux/libs/
|
||||
COPY templates/ /daux/templates/
|
||||
COPY themes/ /daux/themes/
|
||||
COPY daux_libraries/ /daux/daux_libraries/
|
||||
COPY global.json /daux/global.json
|
||||
COPY index.php /daux/index.php
|
||||
|
||||
RUN ln -s /daux/bin/daux /usr/local/bin/daux
|
||||
|
||||
WORKDIR /build
|
||||
|
||||
EXPOSE 8085
|
||||
|
||||
CMD ["daux"]
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,138 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Hello World - 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 Nav__item--open 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 Nav__item--active'><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="../Examples/index.html">Examples</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="../Examples/Hello_World.html">Hello World</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/02_Examples/Hello_World.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>This is just another sample page to get you started. What do you think ?
|
||||
测试一下</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Examples/Code_Highlighting.html">Previous</a></li> <li class=Pager--next><a href="../Examples/Hello_World_de.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>
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Hallo Welt - 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 Nav__item--open 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 Nav__item--active'><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="../Examples/index.html">Examples</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="../Examples/Hello_World_de.html">Hallo Welt</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/02_Examples/Hello_World_de.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>This is a page which has attributes and a overriden Title</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Examples/Hello_World.html">Previous</a></li> <li class=Pager--next><a href="../Examples/привет_мир.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>
|
||||
|
|
@ -0,0 +1,138 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Examples - 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 Nav__item--open 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="../Examples/index.html">Examples</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/02_Examples/index.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<h3 id="page_This-is-a-landing-page-for-the-Examples-section">This is a landing page for the Examples section</h3>
|
||||
<p>Adding a landing page is pretty simple, all you need to do is add an "index.md" file to the related folder.</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Table_of_contents.html">Previous</a></li> <li class=Pager--next><a href="../Examples/Code_Highlighting.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>
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
<!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 ">
|
||||
<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 Nav__item--open 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 Nav__item--active'><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="../Examples/index.html">Examples</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="../Examples/привет_мир.html">привет мир</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/02_Examples/привет_мир.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>We also support UTF-8 file names</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Examples/Hello_World_de.html">Previous</a></li> <li class=Pager--next><a href="../Examples/你好世界.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>
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
<!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 ">
|
||||
<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 Nav__item--open 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 Nav__item--active'><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="../Examples/index.html">Examples</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="../Examples/你好世界.html">你好世界</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/02_Examples/你好世界.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>Even more UTF-8 file names !</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Examples/привет_мир.html">Previous</a></li> <li class=Pager--next><a href="../Configuration/index.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>
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Auto Syntax Highlight - 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 Nav__item--active'><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="../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/Auto_Syntax_Highlight.html">Auto Syntax Highlight</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/Auto_Syntax_Highlight.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>With the help of <a href="https://highlightjs.org/" class="Link--external">highlight.js</a> We can highlight more than 150 languages.</p>
|
||||
<p>To be precise, we support all languages supported by highlight.js <code>9.7.0</code>.</p>
|
||||
<p>Here is a quick example :</p>
|
||||
<p><strong>HTML (with inline css and javascript)</strong></p>
|
||||
<pre><code><!DOCTYPE html>
|
||||
<title>Title</title>
|
||||
|
||||
<style>body {width: 500px;}</style>
|
||||
|
||||
<script type="application/javascript">
|
||||
function $init() {return true;}
|
||||
</script>
|
||||
|
||||
<body>
|
||||
<p checked class="title" id='title'>Title</p>
|
||||
<!-- here goes the rest of the page -->
|
||||
</body>
|
||||
</code></pre>
|
||||
<p><a href="../Examples/Code_Highlighting.html">See more examples of supported languages</a></p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Getting_Started.html">Previous</a></li> <li class=Pager--next><a href="../Features/CommonMark_compliant.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>
|
||||
|
|
@ -0,0 +1,246 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>CommonMark compliant - 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 Nav__item--active'><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="../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/CommonMark_compliant.html">CommonMark compliant</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/CommonMark_compliant.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>As we support CommonMark, a broad range of markdown features is available to you.</p>
|
||||
<p>Many of the features shown below were known as Github Flavored Markdown.</p>
|
||||
<h2 id="page_We-all-like-making-lists">We all like making lists</h2>
|
||||
<p>The above header should be an H2 tag. Now, for a list of fruits:</p>
|
||||
<ul>
|
||||
<li>Red Apples</li>
|
||||
<li>Purple Grapes</li>
|
||||
<li>Green Kiwifruits</li>
|
||||
</ul>
|
||||
<p>Let's get crazy:</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p>This is a list item with two paragraphs. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||
mi posuere lectus.</p>
|
||||
<p>Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||
sit amet velit.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Suspendisse id sem consectetuer libero luctus adipiscing.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p>What about some code <strong>in</strong> a list? That's insane, right?</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p>In Ruby you can map like this:</p>
|
||||
<pre><code> ['a', 'b'].map { |x| x.uppercase }
|
||||
</code></pre>
|
||||
</li>
|
||||
<li>
|
||||
<p>In Rails, you can do a shortcut:</p>
|
||||
<pre><code> ['a', 'b'].map(&:uppercase)
|
||||
</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
<p>Some people seem to like definition lists</p>
|
||||
<h2 id="page_I-am-a-robot">I am a robot</h2>
|
||||
<p>Maybe you want to print <code>robot</code> to the console 1000 times. Why not?</p>
|
||||
<pre><code>def robot_invasion
|
||||
puts("robot " * 1000)
|
||||
end
|
||||
</code></pre>
|
||||
<p>You see, that was formatted as code because it's been indented by four spaces.</p>
|
||||
<p>How about we throw some angle braces and ampersands in there?</p>
|
||||
<pre><code><div class="footer">
|
||||
&copy; 2004 Foo Corporation
|
||||
</div>
|
||||
</code></pre>
|
||||
<h2 id="page_Set-in-stone">Set in stone</h2>
|
||||
<p>Preformatted blocks are useful for ASCII art:</p>
|
||||
<pre>
|
||||
,-.
|
||||
, ,-. ,-.
|
||||
/ \ ( )-( )
|
||||
\ | ,.>-( )-<
|
||||
\|,' ( )-( )
|
||||
Y ___`-' `-'
|
||||
|/__/ `-'
|
||||
|
|
||||
|
|
||||
| -hrr-
|
||||
___|_____________
|
||||
</pre>
|
||||
<h2 id="page_Playing-the-blame-game">Playing the blame game</h2>
|
||||
<p>If you need to blame someone, the best way to do so is by quoting them:</p>
|
||||
<blockquote>
|
||||
<p>I, at any rate, am convinced that He does not throw dice.</p>
|
||||
</blockquote>
|
||||
<p>Or perhaps someone a little less eloquent:</p>
|
||||
<blockquote>
|
||||
<p>I wish you'd have given me this written question ahead of time so I
|
||||
could plan for it... I'm sure something will pop into my head here in
|
||||
the midst of this press conference, with all the pressure of trying to
|
||||
come up with answer, but it hadn't yet...</p>
|
||||
<p>I don't want to sound like
|
||||
I have made no mistakes. I'm confident I have. I just haven't - you
|
||||
just put me under the spot here, and maybe I'm not as quick on my feet
|
||||
as I should be in coming up with one.</p>
|
||||
</blockquote>
|
||||
<h2 id="page_Table-for-two">Table for two</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>ID</th>
|
||||
<th align="center">Name</th>
|
||||
<th align="right">Rank</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td align="center">Tom Preston-Werner</td>
|
||||
<td align="right">Awesome</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>2</td>
|
||||
<td align="center">Albert Einstein</td>
|
||||
<td align="right">Nearly as awesome</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="page_Crazy-linking-action">Crazy linking action</h2>
|
||||
<p>I get 10 times more traffic from [Google] <a href="http://google.com/" title="Google" class="Link--external">1</a> than from
|
||||
[Yahoo] <a href="http://search.yahoo.com/" title="Yahoo Search" class="Link--external">2</a> or [MSN] <a href="http://search.msn.com/" title="MSN Search" class="Link--external">3</a>.</p>
|
||||
<h2 id="page_Images">Images</h2>
|
||||
<p>Here's an image.</p>
|
||||
<p><img src="sampleimage.png" alt="This is an image" /></p>
|
||||
<p>Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image.</p>
|
||||
<p><em>View the <a href="https://github.com/dauxio/daux.io/blob/master/docs/01_Features/CommonMark_compliant.md" class="Link--external">source of this content</a>.</em></p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Auto_Syntax_Highlight.html">Previous</a></li> <li class=Pager--next><a href="../Features/Edit_on_GitHub_links.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>
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Edit on GitHub links - 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 Nav__item--active'><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="../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/Edit_on_GitHub_links.html">Edit on GitHub links</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/Edit_on_GitHub_links.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>As you can see on the top of this page, you can add "Edit on Github" links to your pages, this feature can be enabled with a single parameter.</p>
|
||||
<p>The value has to be the path to the root of your documentation folder in your repository.</p>
|
||||
<p>In the value you see below, Daux's documentation is in the <code>docs</code> folder in the <code>master</code> branch.</p>
|
||||
<p>Daux.io will handle the rest</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"edit_on_github": "dauxio/daux.io/blob/master/docs"
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="page_Edit-on-other-VCS">Edit on other VCS</h2>
|
||||
<p>While GitHub is the most popular, it isn't the only, collaborative VCS out there.</p>
|
||||
<p>As long as you can refer your files by a URL, you can create an edit link for your VCS with the following configuration:</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"edit_on": {
|
||||
"name": "Bitbucket",
|
||||
"basepath": "https://bitbucket.org/dauxio/daux.io/src/master/docs"
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/CommonMark_compliant.html">Previous</a></li> <li class=Pager--next><a href="../Features/Front_Matter.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>
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Front Matter - DAUX.IO</title>
|
||||
<meta name="description" content="With Front Matter you can customize your pages even further.">
|
||||
<meta name="keywords" content="Front Matter, Customize, Title, Description, Keywords, Author">
|
||||
<meta name="author" content="Daux.io Team">
|
||||
<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 Nav__item--active'><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="../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/Front_Matter.html">Front Matter</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/Front_Matter.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>To customize your pages even further, you can add a Front Matter to your files.</p>
|
||||
<p>Front Matter is a block you add at the top of your file and looks like this:</p>
|
||||
<pre><code>---
|
||||
title: Hallo Welt
|
||||
keywords: "Hallo, Hello, Welt, World, Erde, Earth"
|
||||
author: German Daux.io Team
|
||||
date: 12th December 1984
|
||||
---
|
||||
</code></pre>
|
||||
<h2 id="page_Changing-the-title">Changing the title</h2>
|
||||
<p>If your file is named "Hello_World_de.md" and your front matter is the one displayed above, you will get a page named "Hallo Welt"</p>
|
||||
<h2 id="page_Search-Engine-Optimization">Search Engine Optimization</h2>
|
||||
<p>For a better <strong>SEO</strong> experience you can change the <code>description</code>, <code>keywords</code> and <code>author</code> meta tags.</p>
|
||||
<h2 id="page_For-Developers">For Developers</h2>
|
||||
<p>You can then access this information in each <code>Content</code> with <code>$content->getAttributes()</code> or with <code>$page['attributes']</code> in a template.</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Edit_on_GitHub_links.html">Previous</a></li> <li class=Pager--next><a href="../Features/Internal_links.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>
|
||||
|
|
@ -0,0 +1,176 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Internal links - 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 Nav__item--active'><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="../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/Internal_links.html">Internal links</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/Internal_links.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>You can create links from a page to an other, the link is then resolved to the real page.</p>
|
||||
<p>Each relative link in your pages will be resolved to a page or content within the documentation.
|
||||
If the link's destination isn't found, the page generation will fail.</p>
|
||||
<p>Any valid markdown link is a valid Daux.io link.</p>
|
||||
<p>If your file structure looks like this:</p>
|
||||
<pre><code>├── 00_Getting_Started.md
|
||||
├── 01_Features
|
||||
│ ├── CommonMark_compliant.md
|
||||
├── 02_Examples
|
||||
│ ├── Hello_World.md
|
||||
│ ├── 05_Code_Highlighting.md
|
||||
</code></pre>
|
||||
<p>From the page <code>01_Features/CommonMark_compliant.md</code>, all the following links would be valid:</p>
|
||||
<pre><code>[Getting Started](../00_Getting_Started.md)
|
||||
[Getting Started](../00_Getting_Started.html)
|
||||
[Getting Started](../00_Getting_Started)
|
||||
[Getting Started](../Getting_Started)
|
||||
|
||||
// A link starting with / means root of the documentation, not the server it will be served from.
|
||||
[Getting Started](/Getting_Started.html)
|
||||
[Getting Started](/Getting_Started)
|
||||
|
||||
// These Will first be searched for in the current directory and then start at the root of the documentation
|
||||
[Getting Started](Getting_Started)
|
||||
[Getting Started](00_Getting_Started)
|
||||
|
||||
[Hello World](../02_Examples/Hello_World.md)
|
||||
[Hello World](../02_Examples/Hello_World.html)
|
||||
[Hello World](../02_Examples/Hello_World)
|
||||
[Hello World](../Examples/Hello_World)
|
||||
[Hello World](/02_Examples/Hello_World.md)
|
||||
[Hello World](Examples/Hello_World)
|
||||
[Hello World](02_Examples/Hello_World)
|
||||
</code></pre>
|
||||
<h2 id="page_Github-publishing">Github publishing</h2>
|
||||
<p>If you plan to publish your documentation on Github along with your source code, we recommend to only use relative links with full names.</p>
|
||||
<p>From the list of links above only these two will work both on Github and on Daux.io</p>
|
||||
<pre><code>[Getting Started](../00_Getting_Started.md)
|
||||
[Hello World](../02_Examples/Hello_World.md)
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Front_Matter.html">Previous</a></li> <li class=Pager--next><a href="../Features/Landing_page.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>
|
||||
|
|
@ -0,0 +1,153 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Landing page - 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 Nav__item--active'><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="../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/Landing_page.html">Landing page</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/Landing_page.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>If you want to create a beautiful landing page for your project, create a <code>_index.md</code> file in the root of the <code>/docs</code> folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:</p>
|
||||
<pre><code class="language-json">{
|
||||
"title": "Daux.io",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"image": "app.png"
|
||||
}
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The image can be a local or remote image. By default, the path is relative to the root of the documentation.</p>
|
||||
</blockquote>
|
||||
<p>To disable the automatic landing page, you can set <code>auto_landing</code> to false in the <code>html</code> section of your configuration</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"auto_landing": false
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Internal_links.html">Previous</a></li> <li class=Pager--next><a href="../Features/Live_mode.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>
|
||||
|
|
@ -0,0 +1,223 @@
|
|||
<!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>
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Multilanguage - 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 '><a href="../Features/Live_mode.html">Live mode</a></li><li class='Nav__item Nav__item--active'><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/Multilanguage.html">Multilanguage</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/Multilanguage.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>You can handle multiple languages in your documentation, each with it's own navigation.</p>
|
||||
<p>Add this to your config.json :</p>
|
||||
<pre><code class="language-json">{
|
||||
"languages": { "en": "English", "de": "German" }
|
||||
}
|
||||
</code></pre>
|
||||
<p>You will the need separate directories for each language in <code>docs/</code> folder.</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>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Live_mode.html">Previous</a></li> <li class=Pager--next><a href="../Features/Multiple_Output_Formats.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>
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Multiple Output Formats - 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 '><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 Nav__item--active'><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/Multiple_Output_Formats.html">Multiple Output Formats</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/Multiple_Output_Formats.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>Daux.io is extendable and comes by default with three export formats:</p>
|
||||
<ul>
|
||||
<li>Export to HTML</li>
|
||||
<li>Export all documentation in a single HTML page</li>
|
||||
<li>Upload to your Atlassian Confluence server</li>
|
||||
</ul>
|
||||
<h2 id="page_Feature-Matrix">Feature Matrix</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="right">Feature</th>
|
||||
<th align="center">HTML</th>
|
||||
<th align="center">Single Page HTML</th>
|
||||
<th align="center">Confluence</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="right">Multilanguage</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X (Planned)</td>
|
||||
<td align="center">X</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Landing Pages</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X</td>
|
||||
<td align="center">X</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Index Pages</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">√</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Internal Links</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X (Planned)</td>
|
||||
<td align="center">√</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Code Highlight</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X (Planned)</td>
|
||||
<td align="center">√ (Using macros)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Live Mode</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X</td>
|
||||
<td align="center">X</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Pages Ordering</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">X (API Limitation)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="right">Google / Piwik analytics</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">√</td>
|
||||
<td align="center">√ (Configured on Conflence)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="page_Confluence-Example">Confluence Example</h2>
|
||||
<p>You can see this documentation uploaded to Confluence : https://dauxio.atlassian.net/wiki/spaces/DOC/overview</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Multilanguage.html">Previous</a></li> <li class=Pager--next><a href="../Features/Navigation_and_Sorting.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>
|
||||
|
|
@ -0,0 +1,164 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Navigation and Sorting - 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 '><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 Nav__item--active'><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/Navigation_and_Sorting.html">Navigation and Sorting</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/Navigation_and_Sorting.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<h2 id="page_Navigation">Navigation</h2>
|
||||
<p>The navigation is generated automatically with all pages that end with <code>.md</code> or <code>.markdown</code></p>
|
||||
<p>You can have as many sub levels as you wish.</p>
|
||||
<p>By default, a folder will have no index page.
|
||||
if you wish to have one defined all you need to do is add an <code>index.md</code> file to the folder.
|
||||
For example, <code>/docs/02_Examples</code> has a landing page for that section since there exists a <code>/docs/02_Examples/index.md</code> file.</p>
|
||||
<h2 id="page_Sorting">Sorting</h2>
|
||||
<p>To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. <code>/docs/01_Hello_World.md</code> and <code>/docs/05_Features.md</code>.
|
||||
This will list <em>Hello World</em> before <em>Features</em>, overriding the default alpha-numeric sorting.
|
||||
The numbers will be stripped out of the navigation and urls. For the file <code>6 Ways to Get Rich</code>, you can use <code>/docs/_6_Ways_to_Get_Rich.md</code></p>
|
||||
<p>You might also wish to stick certain links to the bottom of a page.
|
||||
You can do so by prefixing the file name with a '-', e.g. a new file <code>/docs/-Contact_Us.md</code> will always appear at the bottom of the current list.
|
||||
Weights can also be added to further sort the bottom entries. e.g. <code>/docs/-01_Coming.md</code> will appear before <code>/docs/-02_Soon.md</code> but both will only appear after all positive or non-weighted files.</p>
|
||||
<p>It works the same for files prefixed with <code>+</code>.</p>
|
||||
<p>Page order priorities are like this:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<code>+</code> in front of the filename and numbers in front</li>
|
||||
<li>
|
||||
<code>+</code> in front of the filename</li>
|
||||
<li>The index page</li>
|
||||
<li>Numbers in the front</li>
|
||||
<li>Pages without prefix</li>
|
||||
<li>
|
||||
<code>-</code> in front of the filename and numbers in front</li>
|
||||
<li>
|
||||
<code>-</code> in front of the filename</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Multiple_Output_Formats.html">Previous</a></li> <li class=Pager--next><a href="../Features/Search.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>
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Search - 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 '><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 Nav__item--active'><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/Search.html">Search</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/Search.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>Searching in a Daux.io documentation is possible, but only in static mode.</p>
|
||||
<p>We don't provide this feature in live rendering as it would be too slow.</p>
|
||||
<p>To enable the generated search, you can set <code>search</code> to true in the <code>html</code> section of your configuration</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"search": true
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Navigation_and_Sorting.html">Previous</a></li> <li class=Pager--next><a href="../Features/Static_Site_Generation.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>
|
||||
|
|
@ -0,0 +1,172 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Static Site Generation - 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 '><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 Nav__item--active'><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/Static_Site_Generation.html">Static Site Generation</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/Static_Site_Generation.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>If you don't want to serve the live version of your site, you can also generate files, these can be one of the three supported formats :</p>
|
||||
<ul>
|
||||
<li>HTML output</li>
|
||||
<li>Single page HTML output</li>
|
||||
<li>Atlassian Confluence upload</li>
|
||||
</ul>
|
||||
<p>Generating a complete set of pages, with navigation</p>
|
||||
<pre><code class="language-bash">daux --destination=[Output Directory Relative Direction]
|
||||
</code></pre>
|
||||
<h2 id="page_Options">Options</h2>
|
||||
<p>For more options, run</p>
|
||||
<pre><code class="language-bash">daux generate --help
|
||||
</code></pre>
|
||||
<h3 id="page_Specify-the-configuration-file">Specify the configuration file</h3>
|
||||
<h3 id="page_Specify-the-format">Specify the format</h3>
|
||||
<p>Valid options are <code>html</code>, <code>confluence</code> or <code>html-file</code>.
|
||||
You can also add your own formats through Processors</p>
|
||||
<pre><code class="language-bash">daux --format=html
|
||||
</code></pre>
|
||||
<h3 id="page_Specify-a-processor">Specify a processor</h3>
|
||||
<p>A processor can be specified through the <code>--processor</code> option, this should be the name of a class inside the <code>Todaymade\Daux\Extension</code> namespace.</p>
|
||||
<p>By running :</p>
|
||||
<pre><code class="language-bash">daux --processor=Processor
|
||||
</code></pre>
|
||||
<p>Daux will be looking for <code>Todaymade\Daux\Extension\Processor</code> inside the <code>daux</code> folder.</p>
|
||||
<p>You can try to run this command, we added a small example Processor.</p>
|
||||
<h3 id="page_Specify-the-source">Specify the source</h3>
|
||||
<p>By default, the source is taken from the <code>docs_directory</code> configuration value in <code>global.json</code> but you can override it here.</p>
|
||||
<pre><code class="language-bash">daux --source=docs_to_generate
|
||||
</code></pre>
|
||||
<p>The path can be absolute or relative</p>
|
||||
<h3 id="page_Specify-the-destination">Specify the destination</h3>
|
||||
<p>By default the destination is <code>static</code></p>
|
||||
<pre><code class="language-bash">daux --destination=generated_docs
|
||||
</code></pre>
|
||||
<p>The path can be absolute or relative</p>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Search.html">Previous</a></li> <li class=Pager--next><a href="../Features/Table_of_contents.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>
|
||||
|
|
@ -0,0 +1,153 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Table of contents - 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 '><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 Nav__item--active'><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/Table_of_contents.html">Table of contents</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/Table_of_contents.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>Adding a table of contents becomes very easy with Daux.io</p>
|
||||
<h2 id="page_Manual">Manual</h2>
|
||||
<p>Add <code>[TOC]</code> anywhere in your document and it will be replaced by a table of contents.</p>
|
||||
<p>You can add it more than once in a page.</p>
|
||||
<h2 id="page_Automatic">Automatic</h2>
|
||||
<blockquote>
|
||||
<p>Works only for html mode</p>
|
||||
</blockquote>
|
||||
<p>A table of contents can be added automatically to all pages.</p>
|
||||
<p>If <code>[TOC]</code> isn't present it will add it at the beginning of the page.</p>
|
||||
<p>You can enable this feature in your configuration</p>
|
||||
<pre><code class="language-json">{
|
||||
"html": {
|
||||
"auto_toc": true
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Features/Static_Site_Generation.html">Previous</a></li> <li class=Pager--next><a href="../Examples/index.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>
|
||||
|
Before Width: | Height: | Size: 3.1 KiB After Width: | Height: | Size: 3.1 KiB |
|
|
@ -0,0 +1,193 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Creating a Processor - 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 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 Nav__item--open 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 Nav__item--active'><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="../For_Developers/Creating_a_Processor.html">For Developers</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="../For_Developers/Creating_a_Processor.html">Creating a Processor</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/10_For_Developers/Creating_a_Processor.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>The recommended way to extend Daux is through Processors.</p>
|
||||
<p>The main advantage, is that you can run it with the source or with <code>daux</code> independently. You don't need to hack in the core.</p>
|
||||
<h2 id="page_Adding-classes">Adding classes</h2>
|
||||
<p>Next to your <code>docs</code> directory, you can create a <code>daux</code> directory that can contain your Processor.</p>
|
||||
<p>The classes must respect the PSR-4 Naming convention. And have <code>\Todaymade\Daux\Extension</code> as a base namespace.</p>
|
||||
<p>By default, we created a <code>daux/Processor.php</code> file to get you started.</p>
|
||||
<h2 id="page_A-quick-test">A quick test ?</h2>
|
||||
<p>For the example we're just going to dump the tree and exit.</p>
|
||||
<pre><code class="language-php">public function manipulateTree(Root $root)
|
||||
{
|
||||
print_r($root->dump());
|
||||
exit;
|
||||
}
|
||||
</code></pre>
|
||||
<p>also, add this at the beginning of the file:</p>
|
||||
<pre><code class="language-php">use Todaymade\Daux\Tree\Root;
|
||||
</code></pre>
|
||||
<p>Let's just try if it works by running <code>daux --processor=Processor</code></p>
|
||||
<p>Yes, you get a big array dump! You're good to go.</p>
|
||||
<h2 id="page_What-can-I-achieve">What can I achieve ?</h2>
|
||||
<p>There are a few methods that you can override to add some</p>
|
||||
<h3 id="page_Change-the-parsed-tree">Change the parsed tree.</h3>
|
||||
<p>By default, Daux.io parses your directory to find pages. but, for a reason or another, you might want to programmatically add some pages.</p>
|
||||
<p>This can be done with:</p>
|
||||
<pre><code class="language-php">public function manipulateTree(Root $root)
|
||||
{
|
||||
}
|
||||
</code></pre>
|
||||
<p>Two helpers from the class <code>Todaymade\Daux\Tree\Builder</code> will greatly help you doing that:</p>
|
||||
<pre><code class="language-php">$new = Builder::getOrCreateDir($root, 'New Pages');
|
||||
|
||||
$page = Builder::getOrCreatePage($new, 'index');
|
||||
$page->setContent('The index page for the new folder');
|
||||
|
||||
$page = Builder::getOrCreatePage($new, 'A New Hope');
|
||||
$page->setContent('A long time ago in a galaxy far away');
|
||||
</code></pre>
|
||||
<p>Both methods <code>getOrCreateDir</code> and <code>getOrCreatePage</code> take two parameters : <code>parent</code> and <code>title</code></p>
|
||||
<p>The page will automatically be treated as markdown and converted like a normal page.</p>
|
||||
<p>If you create a new ContentType, like let's say LaTeX, you would set the title <code>My Page.tex</code> it will keep the title <code>My Page</code> and use your renderer.</p>
|
||||
<p>If the extension is not mapped to a Generator, it will simply create the file as-is without manipulation.</p>
|
||||
<h3 id="page_Extend-the-Markdown-Generator">Extend the Markdown Generator</h3>
|
||||
<p>You can extend the Markdown Parser in any way wou want with this method.</p>
|
||||
<pre><code class="language-php">public function extendCommonMarkEnvironment(Environment $environment)
|
||||
{
|
||||
}
|
||||
</code></pre>
|
||||
<p>See the details on <a href="http://commonmark.thephpleague.com/customization/overview/" class="Link--external">CommonMark's website</a>.</p>
|
||||
<h3 id="page_Add-new-generators">Add new generators</h3>
|
||||
<p>You can add new generators to Daux.io and use them right away, they must implement the
|
||||
<code>\Todaymade\Daux\Format\Base\Generator</code> interface and if you want to use the live mode with your generator
|
||||
you have to implement <code>\Todaymade\Daux\Format\Base\LiveGenerator</code>.</p>
|
||||
<pre><code class="language-php">public function addGenerators()
|
||||
{
|
||||
return ['custom_generator' => '\Todaymade\Daux\Extension\MyNewGenerator'];
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../Configuration/Html_export.html">Previous</a></li> <li class=Pager--next><a href="../For_Developers/Creating_a_Theme.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>
|
||||
|
|
@ -0,0 +1,222 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<title>Creating a Theme - 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 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 Nav__item--open 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 Nav__item--active'><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="../For_Developers/Creating_a_Processor.html">For Developers</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="../For_Developers/Creating_a_Theme.html">Creating a Theme</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/10_For_Developers/Creating_a_Theme.md" target="_blank">
|
||||
Edit on GitHub </a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="s-content">
|
||||
<p>In its simplest form, a theme is an empty folder with a <code>config.json</code> file containing <code>{}</code></p>
|
||||
<p>After that, every setting is optional, but you can override everything if you'd like to.</p>
|
||||
<h2 id="page_options"><code>config.json</code> options</h2>
|
||||
<p>Here is an example <code>config.json</code> file :</p>
|
||||
<pre><code class="language-json">{
|
||||
"favicon": "<theme_url>img/favicon.png",
|
||||
"css": ["<theme_url>css/theme.min.css"],
|
||||
"js": [],
|
||||
"fonts": ["https://fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic"],
|
||||
"variants": {
|
||||
"blue": {
|
||||
"favicon": "<theme_url>img/favicon-blue.png",
|
||||
"css": ["<theme_url>css/theme-blue.min.css"]
|
||||
},
|
||||
"green": {
|
||||
"favicon": "<theme_url>img/favicon-green.png",
|
||||
"css": ["<theme_url>css/theme-green.min.css"]
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>There are five options :</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code>favicon</code></strong>: The URL to your favicon</li>
|
||||
<li>
|
||||
<strong><code>css</code></strong>: An array of CSS Stylesheets to add to the page</li>
|
||||
<li>
|
||||
<strong><code>js</code></strong>: An array of JavaScript files to load</li>
|
||||
<li>
|
||||
<strong><code>fonts</code></strong>: An array of Font sources, these are added as stylesheets</li>
|
||||
<li>
|
||||
<strong><code>variants</code></strong>: An object containing sub-themes. Each sub theme, can provide the same configurations as the main theme (<code>favicon</code>, <code>css</code>, <code>js</code>, <code>fonts</code>)</li>
|
||||
</ul>
|
||||
<p>You will also notice this <code><theme_url></code> in the url.
|
||||
This is automatically substituted with the final url to the theme when generating the final page.</p>
|
||||
<p>There are two possible substitutions :</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><code><theme_url></code></strong>: The url to the current theme</li>
|
||||
<li>
|
||||
<strong><code><base_url></code></strong>: The url to the documentation root</li>
|
||||
</ul>
|
||||
<h2 id="page_Theme-variants">Theme variants</h2>
|
||||
<p>Like the default Daux.io theme, you might want to provide variants of your theme.</p>
|
||||
<p>In the example before, there were two variants : blue and green.</p>
|
||||
<p>The configuration of a variant is added to the configuration of the main theme, it doesn't replace it.</p>
|
||||
<p>For example the main CSS files defined are: <code>["<theme_url>css/theme.min.css"]</code> and the green variant defines <code>["<theme_url>css/theme-green.min.css"]</code>.</p>
|
||||
<p>The final list of CSS files will be <code>["<theme_url>css/theme.min.css", "<theme_url>css/theme-green.min.css"]</code>.</p>
|
||||
<p>This doesn't apply to <code>favicon</code>, only the last value set is kept.</p>
|
||||
<h2 id="page_Setting-the-theme-for-your-documentation">Setting the theme for your documentation</h2>
|
||||
<p>In your documentation's <code>config.json</code> (not the theme's <code>config.json</code>)</p>
|
||||
<p>Change the <code>theme</code> option inside <code>html</code></p>
|
||||
<pre><code class="language-json">{
|
||||
"themes_directory": "/home/user/themes",
|
||||
"html": {
|
||||
"theme": "{theme}-{variant}"
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>The name of the theme, is the folder name.</p>
|
||||
<p>You can use the <code>themes_directory</code> setting if you want to specify a custom location of your <code>themes</code> folder.</p>
|
||||
<p>A variant is optional, if you want to add one, separate it from the theme with a dash.</p>
|
||||
<h2 id="page_Overriding-templates">Overriding templates</h2>
|
||||
<p>By default, you have a list of templates in <code>templates</code></p>
|
||||
<p>You can create a folder named <code>templates</code> in your theme, copy-paste the original template in that folder, and you can modify it freely.</p>
|
||||
<p>You can even do it one template at a time if you wish to do only small changes.</p>
|
||||
<p>By default, we have the following templates :</p>
|
||||
<ul>
|
||||
<li>
|
||||
<code>content.php</code>: The content page.</li>
|
||||
<li>
|
||||
<code>home.php</code>: The landing page.</li>
|
||||
<li>
|
||||
<code>error.php</code>: The page to show when a page is not found or some other error happened.</li>
|
||||
<li>
|
||||
<code>partials/navbar_content.php</code>: The content of the top navigation bar.</li>
|
||||
<li>
|
||||
<code>partials/google_analytics.php</code>: The script to load Google Analytics.</li>
|
||||
<li>
|
||||
<code>partials/piwik_analytics.php</code>: The script to load Piwik Analytics.</li>
|
||||
<li>
|
||||
<code>layout/00_layout.php</code>: The master template, containing the <code><html></code> tag.</li>
|
||||
<li>
|
||||
<code>layout/05_page.php</code>: The page layout, with left navigation.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<ul class="Pager">
|
||||
<li class=Pager--prev><a href="../For_Developers/Creating_a_Processor.html">Previous</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>
|
||||
|
|
@ -0,0 +1,356 @@
|
|||
<!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>
|
||||
20
LICENSE
20
LICENSE
|
|
@ -1,20 +0,0 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2013 Justin Walsh (http://todaymade.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
248
README.md
248
README.md
|
|
@ -1,248 +0,0 @@
|
|||
# Daux.io
|
||||
|
||||
[](https://github.com/dauxio/daux.io/releases)
|
||||
[](https://github.com/dauxio/daux.io/blob/master/LICENSE.md)
|
||||
|
||||
[](https://scrutinizer-ci.com/g/dauxio/daux.io/code-structure)
|
||||
[](https://scrutinizer-ci.com/g/dauxio/daux.io)
|
||||
[](https://packagist.org/packages/daux/daux.io)
|
||||
|
||||
**Daux.io** 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.
|
||||
|
||||
## Features
|
||||
|
||||
- 100% Mobile Responsive
|
||||
- CommonMark compliant (a Markdown specification)
|
||||
- Supports Markdown tables
|
||||
- Auto created homepage/landing page
|
||||
- Auto Syntax Highlighting
|
||||
- Auto Generated Navigation
|
||||
- 4 Built-In Themes or roll your own
|
||||
- Functional, Flat Design Style
|
||||
- Shareable/Linkable SEO Friendly URLs
|
||||
- Built On Bootstrap
|
||||
- No Build Step
|
||||
- Git/SVN Friendly
|
||||
- Supports Google Analytics and Piwik Analytics
|
||||
- Optional code float layout
|
||||
- Static Output Generation
|
||||
|
||||
## Demos
|
||||
|
||||
This is a list of sites using Daux.io:
|
||||
|
||||
- With a custom theme:
|
||||
- [Crafty](https://swissquote.github.io/crafty)
|
||||
- [Pixolution flow](https://docs.pixolution.org) \* [Soisy](https://doc.soisy.it/)
|
||||
- [Vulkan Tutorial](https://vulkan-tutorial.com) \* [3Q](https://docs.3q.video/)
|
||||
- [The Advanced RSS Environment](https://thearsse.com/manual/)
|
||||
- With the default Theme
|
||||
- [Daux.io](https://daux.io/)
|
||||
_ [DoctrineWatcher](https://dsentker.github.io/WatcherDocumentation/)
|
||||
_ [DrupalGap](http://docs.drupalgap.org/8/)
|
||||
- [ICADMIN: An admin panel powered by CodeIgniter.](http://istocode.com/shared/ic-admin/)
|
||||
- [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
|
||||
- [Nuntius: A PHP framework for bots](https://roysegall.github.io/nuntius-bot/)
|
||||
|
||||
Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/dauxio/daux.io/issues) and I will add you to the list.
|
||||
|
||||
## Install
|
||||
|
||||
### PHP and Composer
|
||||
|
||||
If you have PHP and Composer installed, you can install the dependency
|
||||
|
||||
```bash
|
||||
composer global require daux/daux.io
|
||||
|
||||
# Next to your `docs` folder, run
|
||||
daux generate
|
||||
```
|
||||
|
||||
You can then use the `daux` command line to generate your documentation.
|
||||
|
||||
If the command isn't found, ensure your `$PATH` contains `~/.composer/vendor/bin`
|
||||
|
||||
### Docker
|
||||
|
||||
Or if you wish to use Docker, the start of the command will be :
|
||||
|
||||
```bash
|
||||
docker run --rm -it -w /build -v "$PWD":/build -u "$(id -u):$(id -g)" daux/daux.io daux
|
||||
```
|
||||
|
||||
## Run on a server
|
||||
|
||||
Download this repository as a zip, unpack, and put your documentation in the `docs` folder, you can then serve it with Apache or Nginx.
|
||||
|
||||
## `daux`
|
||||
|
||||
The command line tool has two commands: `generate` and `serve`, running Daux.io without an argument will automatically run the `generate` command.
|
||||
|
||||
You can run `daux --help` to get more details about each command.
|
||||
|
||||
## Folders
|
||||
|
||||
By default, the generator will look for folders in the `docs` folder. Add your folders inside the `docs` folder. This project contains some example folders and files to get you started.
|
||||
|
||||
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.
|
||||
|
||||
If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the `global.json` file.
|
||||
|
||||
## Files
|
||||
|
||||
The generator will look for Markdown files (`*.md` and `*.markdown`) inside the `docs` folder and any of the subfolders within `docs`.
|
||||
|
||||
You must use underscores instead of spaces. Here are some example file names and what they will be converted to:
|
||||
|
||||
**Good:**
|
||||
|
||||
- 01_Getting_Started.md = Getting Started
|
||||
- API_Calls.md = API Calls
|
||||
- 200_Something_Else-Cool.md = Something Else-Cool
|
||||
- \_5_Ways_to_Be_Happy.md = 5 Ways To Be Happy
|
||||
|
||||
**Bad:**
|
||||
|
||||
- File Name With Space.md = FAIL
|
||||
|
||||
## Sorting
|
||||
|
||||
To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md` This will list _Hello World_ before _Features_, overriding the default alpha-numeric sorting. The numbers will be stripped out of the navigation and urls. For the file `6 Ways to Get Rich`, you can use `/docs/_6_Ways_to_Get_Rich.md`
|
||||
|
||||
## Landing page
|
||||
|
||||
If you want to create a beautiful landing page for your project, simply create a `index.md` file in the root of the `/docs` folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"image": "app.png"
|
||||
}
|
||||
```
|
||||
|
||||
Note: The image can be a local or remote image. Use the convention `<base_url>` to refer to the root directory of the Daux instance.
|
||||
|
||||
## Section landing page
|
||||
|
||||
If you are interested in having a landing page for a subsection of your docs, all you need to do is add an `index.md` file to the folder. For example, `/docs/01_Examples` has a landing page for that section since there exists a `/docs/01_Examples/index.md` file. If you wish to have an index page for a section without a landing page format, use the name `_index.md`
|
||||
|
||||
## Configuration
|
||||
|
||||
To customize the look and feel of your documentation, you can create a `config.json` file in the of the `/docs` folder.
|
||||
The `config.json` file is a simple JSON object that you can use to change some of the basic settings of the documentation.
|
||||
|
||||
### Title
|
||||
|
||||
Change the title bar in the docs
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
### Themes
|
||||
|
||||
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
|
||||
|
||||
- daux-blue
|
||||
- daux-green
|
||||
- daux-navy
|
||||
- daux-red
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "theme": "daux-green" }
|
||||
}
|
||||
```
|
||||
|
||||
### More options
|
||||
|
||||
Many other options are available:
|
||||
|
||||
- [Global options](http://daux.io/Configuration/index)
|
||||
- [HTML Options](http://daux.io/Configuration/Html_export)
|
||||
- [Confluence options](http://daux.io/Configuration/Confluence_upload)
|
||||
|
||||
## Running Remotely
|
||||
|
||||
Copy the files from the repo to a web server that can run PHP 7.2.0 or newer.
|
||||
|
||||
## Running Locally
|
||||
|
||||
There are several ways to run the docs locally.
|
||||
The recommended way is to run `daux serve` which will execute PHP's embedded server.
|
||||
|
||||
By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a>
|
||||
|
||||
This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally.
|
||||
|
||||
## Generating a set of static files
|
||||
|
||||
These can be uploaded to a static site hosting service such as pages.github.com
|
||||
|
||||
Generating a complete set of pages, with navigation
|
||||
|
||||
```bash
|
||||
daux --source=docs --destination=static
|
||||
```
|
||||
|
||||
## Running on IIS
|
||||
|
||||
If you have set up a local or remote IIS web site, you may need a `web.config` with:
|
||||
|
||||
- A rewrite configuration, for handling clean urls.
|
||||
- A mime type handler for less files, if using a custom theme.
|
||||
|
||||
### Clean URLs
|
||||
|
||||
The `web.config` needs an entry for `<rewrite>` under `<system.webServer>`:
|
||||
|
||||
```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>
|
||||
```
|
||||
|
||||
To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as [URL Rewriter](http://urlrewriter.net/).
|
||||
|
||||
## PHP Requirements
|
||||
|
||||
Daux.io is compatible with the [officially supported](https://www.php.net/supported-versions.php) PHP versions; 7.2.0 and up.
|
||||
|
||||
### Extensions
|
||||
|
||||
Daux.io needs the following PHP extensions to work : `php-mbstring` and `php-xml`.
|
||||
|
||||
If you encounter an error similar to `utf8_decode() not found` this means that you're missing the `php-xml` package.
|
||||
|
||||
## Support
|
||||
|
||||
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>.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
71
bin/daux
71
bin/daux
|
|
@ -1,71 +0,0 @@
|
|||
#!/usr/bin/env php
|
||||
<?php
|
||||
/*
|
||||
|
||||
Daux.io
|
||||
==================
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This is a tool for auto-generating documentation based on markdown files
|
||||
located in the /docs folder of the project. To see all of the available
|
||||
options and to read more about how to use the generator, visit:
|
||||
|
||||
https://dauxio.github.io/
|
||||
|
||||
|
||||
Author
|
||||
------
|
||||
Stéphane Goetz: onigoetz@onigoetz.ch, @onigoetz
|
||||
Justin Walsh (Todaymade): justin@todaymade.com, @justin_walsh
|
||||
Garrett Moon (Todaymade): garrett@todaymade.com, @garrett_moon
|
||||
|
||||
|
||||
Feedback & Suggestions
|
||||
----
|
||||
|
||||
To give us feedback or to suggest an idea, please create an request on the the
|
||||
GitHub issue tracker:
|
||||
|
||||
https://github.com/dauxio/daux.io/issues
|
||||
|
||||
Bugs
|
||||
----
|
||||
|
||||
To file bug reports please create an issue using the github issue tracker:
|
||||
|
||||
https://github.com/dauxio/daux.io/issues
|
||||
|
||||
|
||||
Copyright and License
|
||||
---------------------
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
This software is provided by the copyright holders and contributors "as
|
||||
is" and any express or implied warranties, including, but not limited
|
||||
to, the implied warranties of merchantability and fitness for a
|
||||
particular purpose are disclaimed. In no event shall the copyright owner
|
||||
or contributors be liable for any direct, indirect, incidental, special,
|
||||
exemplary, or consequential damages (including, but not limited to,
|
||||
procurement of substitute goods or services; loss of use, data, or
|
||||
profits; or business interruption) however caused and on any theory of
|
||||
liability, whether in contract, strict liability, or tort (including
|
||||
negligence or otherwise) arising in any way out of the use of this
|
||||
software, even if advised of the possibility of such damage.
|
||||
|
||||
*/
|
||||
|
||||
require_once(__DIR__ . '/../libs/bootstrap.php');
|
||||
|
||||
$application = new \Todaymade\Daux\Console\Application();
|
||||
$application->run();
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
{
|
||||
"name": "d3/daux.io",
|
||||
"type": "project",
|
||||
"license": "MIT",
|
||||
"description": "Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly",
|
||||
"keywords": ["documentation", "docs", "markdown", "md"],
|
||||
"homepage": "https://dauxio.github.io/",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Stéphane Goetz",
|
||||
"homepage": "http://onigoetz.ch/"
|
||||
},
|
||||
{
|
||||
"name": "Justin Walsh",
|
||||
"homepage": "http://todaymade.com/"
|
||||
}
|
||||
],
|
||||
"bin": ["bin/daux"],
|
||||
"require": {
|
||||
"php": ">=7.2",
|
||||
"guzzlehttp/guzzle": "~6.0",
|
||||
"league/commonmark": "^1.0.0",
|
||||
"league/plates": "~3.1",
|
||||
"myclabs/deep-copy": "^1.5",
|
||||
"scrivo/highlight.php": "^9.15",
|
||||
"symfony/console": "^5.0",
|
||||
"symfony/http-foundation": "^5.0",
|
||||
"symfony/mime": "^5.0",
|
||||
"symfony/polyfill-intl-icu": "^1.10",
|
||||
"symfony/process": "^5.0",
|
||||
"webuni/front-matter": "^1.0.0",
|
||||
"ext-json": "*"
|
||||
},
|
||||
"suggest":{
|
||||
"ext-intl": "Allows to translate the modified at date"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Todaymade\\Daux\\": "libs/"
|
||||
}
|
||||
},
|
||||
"replace": {
|
||||
"justinwalsh/daux.io": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"mikey179/vfsstream": "^1.6"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "build/phpunit",
|
||||
"test:coverage-html": "build/phpunit --coverage-html=build/coverage",
|
||||
"lint": "build/php-cs-fixer fix --config=.php_cs --dry-run -v",
|
||||
"lint:fix": "build/php-cs-fixer fix --config=.php_cs"
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,67 +0,0 @@
|
|||
module.exports = {
|
||||
browsers: "defaults, not op_mini all",
|
||||
presets: [
|
||||
"@swissquote/crafty-preset-babel",
|
||||
"@swissquote/crafty-runner-rollup",
|
||||
"@swissquote/crafty-preset-postcss",
|
||||
"@swissquote/crafty-runner-gulp"
|
||||
],
|
||||
destination_css: ".",
|
||||
destination_js: ".",
|
||||
stylelint_pattern: [
|
||||
"src/css/**/*.scss",
|
||||
"!*.min.css",
|
||||
"!**/vendor/**/*.scss"
|
||||
],
|
||||
stylelint: {
|
||||
rules: {
|
||||
"swissquote/no-type-outside-scope": null,
|
||||
"plugin/no-unsupported-browser-features": null
|
||||
}
|
||||
},
|
||||
js: {
|
||||
search: {
|
||||
runner: "rollup",
|
||||
format: "iife",
|
||||
source: "src/js/search/index.js",
|
||||
destination: "daux_libraries/search.min.js"
|
||||
},
|
||||
theme_daux: {
|
||||
runner: "rollup",
|
||||
format: "iife",
|
||||
source: "src/js/theme_daux/index.js",
|
||||
destination: "themes/daux/js/daux.min.js"
|
||||
}
|
||||
},
|
||||
css: {
|
||||
theme_blue: {
|
||||
source: "src/css/theme_daux/theme-blue.scss",
|
||||
destination: "themes/daux/css/theme-blue.min.css",
|
||||
watch: ["src/css/**/*.scss"]
|
||||
},
|
||||
theme_green: {
|
||||
source: "src/css/theme_daux/theme-green.scss",
|
||||
destination: "themes/daux/css/theme-green.min.css",
|
||||
watch: ["src/css/**/*.scss"]
|
||||
},
|
||||
theme_navy: {
|
||||
source: "src/css/theme_daux/theme-navy.scss",
|
||||
destination: "themes/daux/css/theme-navy.min.css",
|
||||
watch: ["src/css/**/*.scss"]
|
||||
},
|
||||
theme_red: {
|
||||
source: "src/css/theme_daux/theme-red.scss",
|
||||
destination: "themes/daux/css/theme-red.min.css",
|
||||
watch: ["src/css/**/*.scss"]
|
||||
},
|
||||
daux_singlepage: {
|
||||
source: "src/css/theme_daux_singlepage/main.scss",
|
||||
destination: "themes/daux_singlepage/css/main.min.css",
|
||||
watch: ["src/css/**/*.scss"]
|
||||
}
|
||||
},
|
||||
postcss(crafty, config, bundle) {
|
||||
// Add postcss-page-break
|
||||
config.processor("postcss-page-break").before("autoprefixer");
|
||||
}
|
||||
};
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<?php namespace Todaymade\Daux\Extension;
|
||||
|
||||
use Todaymade\Daux\Tree\Root;
|
||||
|
||||
class Processor extends \Todaymade\Daux\Processor
|
||||
{
|
||||
public function manipulateTree(Root $root)
|
||||
{
|
||||
print_r($root->dump());
|
||||
}
|
||||
}
|
||||
|
|
@ -1,192 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace Todaymade\Daux\Extension;
|
||||
|
||||
use League\CommonMark\Block\Element\BlockQuote;
|
||||
use League\CommonMark\Block\Element\Document;
|
||||
use League\CommonMark\Block\Element\Paragraph;
|
||||
use League\CommonMark\Environment;
|
||||
use League\CommonMark\ElementRendererInterface;
|
||||
use League\CommonMark\InlineParserContext;
|
||||
use League\CommonMark\HtmlElement;
|
||||
use League\CommonMark\Inline\Parser\AbstractInlineParser;
|
||||
use League\CommonMark\Block\Renderer\BlockRendererInterface;
|
||||
use League\CommonMark\Inline\Renderer\InlineRendererInterface;
|
||||
USE League\CommonMark\Block\Element\AbstractBlock;
|
||||
USE League\CommonMark\Inline\Element\AbstractInline;
|
||||
use League\CommonMark\Inline\Element\Code;
|
||||
use League\CommonMark\Inline\Element\Text;
|
||||
use League\CommonMark\Util\Configuration;
|
||||
use Todaymade\Daux\Daux;
|
||||
use Symfony\Component\Console\Output\NullOutput;
|
||||
|
||||
class d3Parser extends AbstractInlineParser
|
||||
{
|
||||
public function getCharacters() {
|
||||
return ['v', 'V'];
|
||||
}
|
||||
|
||||
public function parse(InlineParserContext $inlineContext)
|
||||
{
|
||||
$cursor = $inlineContext->getCursor();
|
||||
|
||||
if ($cursor->match('/D3/')) {
|
||||
$inlineContext->getContainer()->appendChild(new Code('d3logo'));
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
class d3BlockQuoteRenderer implements BlockRendererInterface
|
||||
{
|
||||
public function render(AbstractBlock $block, ElementRendererInterface $htmlRenderer, $inTightList = false)
|
||||
{
|
||||
if (!($block instanceof BlockQuote)) {
|
||||
throw new \InvalidArgumentException('Incompatible block type: ' . get_class($block));
|
||||
}
|
||||
|
||||
$attrs = [];
|
||||
foreach ($block->getData('attributes', []) as $key => $value) {
|
||||
$attrs[$key] = $htmlRenderer->escape($value, true);
|
||||
}
|
||||
|
||||
$filling = $htmlRenderer->renderBlocks($block->children());
|
||||
|
||||
if ($filling === '') {
|
||||
return new HtmlElement('blockquote', $attrs, $htmlRenderer->getOption('inner_separator', "\n"));
|
||||
}
|
||||
|
||||
if (stristr($filling, '[!!]')) {
|
||||
$attrs['class'] = isset($attrs['class']) ? $attrs['class'].' alert alert-danger' : 'alert alert-danger';
|
||||
$filling = "<i class='fas fa-exclamation-circle'></i> ".trim(str_replace('[!!]', '', $filling));
|
||||
}
|
||||
|
||||
if (stristr($filling, '[!]')) {
|
||||
$attrs['class'] = isset($attrs['class']) ? $attrs['class'].' alert alert-warning' : 'alert alert-warning';
|
||||
$filling = "<i class='fas fa-exclamation-triangle'></i> ".trim(str_replace('[!]', '', $filling));
|
||||
}
|
||||
|
||||
if (stristr($filling, '[i]')) {
|
||||
$attrs['class'] = isset($attrs['class']) ? $attrs['class'].' alert alert-info' : 'alert alert-info';
|
||||
$filling = "<i class='fas fa-info-circle'></i> ".trim(str_replace('[i]', '', $filling));
|
||||
}
|
||||
|
||||
return new HtmlElement(
|
||||
'blockquote',
|
||||
$attrs,
|
||||
$htmlRenderer->getOption('inner_separator', "\n") . $filling . $htmlRenderer->getOption('inner_separator', "\n")
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class d3ParagraphRenderer implements BlockRendererInterface
|
||||
{
|
||||
public function render(AbstractBlock $block, ElementRendererInterface $htmlRenderer, $inTightList = false)
|
||||
{
|
||||
if (!($block instanceof Paragraph)) {
|
||||
throw new \InvalidArgumentException('Incompatible block type: ' . get_class($block));
|
||||
}
|
||||
|
||||
$pattern1 = '/\[\s*?(.{3,})\s*?\]/Uis';
|
||||
$replace1 = '<span class="navi_element">\\1</span>';
|
||||
|
||||
if ($inTightList) {
|
||||
$content = $htmlRenderer->renderInlines($block->children());
|
||||
$content = preg_replace($pattern1, $replace1, $content);
|
||||
|
||||
return $content;
|
||||
} else {
|
||||
$attrs = [];
|
||||
foreach ($block->getData('attributes', []) as $key => $value) {
|
||||
$attrs[$key] = $htmlRenderer->escape($value, true);
|
||||
}
|
||||
|
||||
$content = $htmlRenderer->renderInlines($block->children());
|
||||
$content = preg_replace($pattern1, $replace1, $content);
|
||||
|
||||
return new HtmlElement('p', $attrs, $content);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class d3DocumentRenderer implements BlockRendererInterface
|
||||
{
|
||||
public function render(AbstractBlock $block, ElementRendererInterface $htmlRenderer, $inTightList = false)
|
||||
{
|
||||
if (!($block instanceof Document)) {
|
||||
throw new \InvalidArgumentException('Incompatible block type: ' . get_class($block));
|
||||
}
|
||||
|
||||
$wholeDoc = $htmlRenderer->renderBlocks($block->children());
|
||||
|
||||
$output = new NullOutput();
|
||||
$daux = new Daux(Daux::STATIC_MODE, $output);
|
||||
|
||||
foreach ($_SERVER['argv'] as $arg) {
|
||||
if (stristr($arg, '--source=')) {
|
||||
$docsdir = trim(str_replace('--source=', '', $arg));
|
||||
$daux->getParams()->setDocumentationDirectory($docsdir);
|
||||
}
|
||||
}
|
||||
|
||||
$daux->initializeConfiguration();
|
||||
|
||||
$params = $daux->getParams();
|
||||
if (isset($params['variables'])) {
|
||||
$variables = $params['variables'];
|
||||
if (isset($variables) && is_array($variables) && count($variables)) {
|
||||
foreach ($variables as $varname => $varvalue) {
|
||||
$pattern = '/{\$'.$varname.'}/mU';
|
||||
$wholeDoc = preg_replace($pattern, $varvalue, $wholeDoc);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $wholeDoc === '' ? '' : $wholeDoc . "\n";
|
||||
}
|
||||
}
|
||||
|
||||
class d3TextRenderer implements InlineRendererInterface
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param AbstractInline $inline
|
||||
* @param ElementRendererInterface $htmlRenderer
|
||||
* @return HtmlElement|mixed|string
|
||||
* @throws \Todaymade\Daux\Exception
|
||||
*/
|
||||
public function render(AbstractInline $inline, ElementRendererInterface $htmlRenderer)
|
||||
{
|
||||
if (!($inline instanceof Text)) {
|
||||
throw new \InvalidArgumentException('Incompatible inline type: ' . get_class($inline));
|
||||
}
|
||||
|
||||
$content = $htmlRenderer->escape($inline->getContent());
|
||||
|
||||
$search = array(
|
||||
'D3', 'D³', 'D³'
|
||||
);
|
||||
$replace = "<i class='fab fa-d3 d3fa-color-blue'></i>";
|
||||
$content = str_replace($search, $replace, $content);
|
||||
|
||||
return $content;
|
||||
}
|
||||
}
|
||||
|
||||
class d3processor extends \Todaymade\Daux\Processor
|
||||
{
|
||||
public function extendCommonMarkEnvironment(Environment $environment)
|
||||
{
|
||||
// format important and info code blocks
|
||||
$environment->addBlockRenderer('League\CommonMark\Block\Element\BlockQuote', new d3BlockQuoteRenderer());
|
||||
$environment->addBlockRenderer('League\CommonMark\Block\Element\Paragraph', new d3ParagraphRenderer());
|
||||
$environment->addBlockRenderer('League\CommonMark\Block\Element\Document', new d3DocumentRenderer());
|
||||
$environment->addInlineRenderer('League\CommonMark\Inline\Element\Text', new d3TextRenderer());
|
||||
}
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,18 +0,0 @@
|
|||
version: '2'
|
||||
|
||||
services:
|
||||
nginx:
|
||||
image: nginx
|
||||
ports:
|
||||
- 8086:80
|
||||
volumes:
|
||||
- ../:/var/www:ro
|
||||
- ./nginx_default.conf:/etc/nginx/conf.d/default.conf
|
||||
links:
|
||||
- phpserver
|
||||
|
||||
phpserver:
|
||||
image: php:5-fpm
|
||||
working_dir: /var/www/
|
||||
volumes:
|
||||
- ../:/var/www/
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
version: '2'
|
||||
|
||||
services:
|
||||
nginx:
|
||||
image: nginx
|
||||
ports:
|
||||
- 8086:80
|
||||
volumes:
|
||||
- ../:/var/www:ro
|
||||
- ./nginx_default.conf:/etc/nginx/conf.d/default.conf
|
||||
links:
|
||||
- phpserver
|
||||
|
||||
phpserver:
|
||||
image: php:7.4-fpm
|
||||
working_dir: /var/www/
|
||||
volumes:
|
||||
- ../:/var/www/
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
server {
|
||||
listen 80;
|
||||
server_name daux.io;
|
||||
|
||||
index index.php;
|
||||
charset utf-8;
|
||||
|
||||
root /var/www;
|
||||
|
||||
location / {
|
||||
if (!-e $request_filename){
|
||||
rewrite ^(.*)$ /index.php$1;
|
||||
}
|
||||
}
|
||||
|
||||
location ~ \.php {
|
||||
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||
|
||||
fastcgi_pass phpserver:9000;
|
||||
fastcgi_index index.php;
|
||||
|
||||
include fastcgi_params;
|
||||
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||
fastcgi_param PATH_INFO $fastcgi_path_info;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,157 +0,0 @@
|
|||
**Daux.io** 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.
|
||||
|
||||
[TOC]
|
||||
|
||||
## Features
|
||||
|
||||
### For Authors
|
||||
|
||||
- [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)
|
||||
- [Internal documentation links](01_Features/Internal_links.md)
|
||||
- [CommonMark compliant](01_Features/CommonMark_compliant.md)
|
||||
- [Auto created homepage/landing page](01_Features/Landing_page.md)
|
||||
- [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)
|
||||
- [Multiple Languages Support](01_Features/Multilanguage.md)
|
||||
- [No Build Step](01_Features/Live_mode.md)
|
||||
- [Static Output Generation](01_Features/Static_Site_Generation.md)
|
||||
- [Table of Contents](01_Features/Table_of_contents.md)
|
||||
|
||||
### For Developers
|
||||
|
||||
- [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
|
||||
- [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
|
||||
- Full access to the internal API to create new pages programatically
|
||||
- Work with pages metadata
|
||||
|
||||
### For Marketing
|
||||
|
||||
- 100% Mobile Responsive
|
||||
- 4 Built-In Themes or roll your own
|
||||
- Functional, Flat Design Style
|
||||
- Optional code float layout
|
||||
- Shareable/Linkable SEO Friendly URLs
|
||||
- Supports Google Analytics and Piwik Analytics
|
||||
|
||||
## Demos
|
||||
|
||||
This is a list of sites using Daux.io:
|
||||
|
||||
- With a custom theme:
|
||||
- [Crafty](https://swissquote.github.io/crafty)
|
||||
- [Pixolution flow](https://docs.pixolution.org) \* [Soisy](https://doc.soisy.it/)
|
||||
- [Vulkan Tutorial](https://vulkan-tutorial.com)
|
||||
- [3Q](https://docs.3q.video/)
|
||||
- With the default Theme
|
||||
- [Daux.io](https://daux.io/)
|
||||
_ [DoctrineWatcher](https://dsentker.github.io/WatcherDocumentation/)
|
||||
_ [DrupalGap](http://docs.drupalgap.org/8/)
|
||||
- [ICADMIN: An admin panel powered by CodeIgniter.](http://istocode.com/shared/ic-admin/)
|
||||
- [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
|
||||
- [Nuntius: A PHP framework for bots](https://roysegall.github.io/nuntius-bot/)
|
||||
|
||||
Do you use Daux.io? Send us a pull request or open an [issue](https://github.com/dauxio/daux.io/issues) and I will add you to the list.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Install
|
||||
|
||||
#### PHP and Composer
|
||||
|
||||
If you have PHP and Composer installed, you can install the dependency
|
||||
|
||||
```bash
|
||||
composer global require daux/daux.io
|
||||
|
||||
# Next to your `docs` folder, run
|
||||
daux generate
|
||||
```
|
||||
|
||||
You can then use the `daux` command line to generate your documentation.
|
||||
|
||||
If the command isn't found, ensure your `$PATH` contains `~/.composer/vendor/bin` or `~/.config/composer/vendor/bin`.
|
||||
|
||||
#### Docker
|
||||
|
||||
Or if you wish to use Docker, the start of the command will be :
|
||||
|
||||
```bash
|
||||
docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux
|
||||
```
|
||||
|
||||
Any parameter valid in the PHP version is valid in the Docker version
|
||||
|
||||
### Writing pages
|
||||
|
||||
Creating new pages is very easy:
|
||||
|
||||
1. Create a markdown file (`*.md` or `*.markdown`)
|
||||
2. Start writing
|
||||
|
||||
By default, the generator will look for folders in the `docs` folder.
|
||||
Add your folders inside the `docs` folder. This project contains some example folders and files to get you started.
|
||||
|
||||
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.
|
||||
|
||||
You must use underscores instead of spaces. Here are some example file names and what they will be converted to:
|
||||
|
||||
**Good:**
|
||||
|
||||
- 01_Getting_Started.md = Getting Started
|
||||
- API_Calls.md = API Calls
|
||||
- 200_Something_Else-Cool.md = Something Else-Cool
|
||||
- \_5_Ways_to_Be_Happy.md = 5 Ways To Be Happy
|
||||
|
||||
**Bad:**
|
||||
|
||||
- File Name With Space.md = FAIL
|
||||
|
||||
### See your pages
|
||||
|
||||
Now you can see your pages. you have two options for that : serve them directly, or generate to various formats.
|
||||
|
||||
We recommend the first one while you write your documentation, you get a much quicker feedback while writing.
|
||||
|
||||
#### Serving files
|
||||
|
||||
You can use PHP's embedded web server by running the following command in the root of your documentation
|
||||
|
||||
```
|
||||
./serve
|
||||
```
|
||||
|
||||
Upload your files to an apache / nginx server and see your documentation
|
||||
|
||||
[More informations here](01_Features/Live_mode.md)
|
||||
|
||||
#### Export to other formats
|
||||
|
||||
Daux.io is extendable and comes by default with three export formats:
|
||||
|
||||
- Export to HTML, same as the website, but can be hosted without PHP.
|
||||
- Export all documentation in a single HTML page
|
||||
- Upload to your Atlassian Confluence server.
|
||||
|
||||
[See a detailed feature comparison matrix](01_Features/Multiple_Output_Formats.md)
|
||||
|
||||
To export, run the `daux` command and your documentation will be generated in `static` (you can change the destination with the `--destination` option)
|
||||
|
||||
[See here for all options](01_Features/Static_Site_Generation.md)
|
||||
|
||||
## Configuration
|
||||
|
||||
Now that you got the basics, you can also [see what you can configure](05_Configuration/_index.md)
|
||||
|
||||
## PHP Requirements
|
||||
|
||||
Daux.io is compatible with the [officially supported](https://www.php.net/supported-versions.php) PHP versions; 7.2.0 and up.
|
||||
|
||||
### Extensions
|
||||
|
||||
Daux.io needs the following PHP extensions to work : `php-mbstring` and `php-xml`.
|
||||
|
||||
If you encounter an error similar to `utf8_decode() not found` this means that you're missing the `php-xml` package.
|
||||
|
||||
## Support
|
||||
|
||||
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>.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
With the help of [highlight.js](https://highlightjs.org/) We can highlight more than 150 languages.
|
||||
|
||||
To be precise, we support all languages supported by highlight.js `9.7.0`.
|
||||
|
||||
Here is a quick example :
|
||||
|
||||
**HTML (with inline css and javascript)**
|
||||
|
||||
<!DOCTYPE html>
|
||||
<title>Title</title>
|
||||
|
||||
<style>body {width: 500px;}</style>
|
||||
|
||||
<script type="application/javascript">
|
||||
function $init() {return true;}
|
||||
</script>
|
||||
|
||||
<body>
|
||||
<p checked class="title" id='title'>Title</p>
|
||||
<!-- here goes the rest of the page -->
|
||||
</body>
|
||||
|
||||
[See more examples of supported languages](../02_Examples/Code_Highlighting.md)
|
||||
|
|
@ -1,113 +0,0 @@
|
|||
As we support CommonMark, a broad range of markdown features is available to you.
|
||||
|
||||
Many of the features shown below were known as Github Flavored Markdown.
|
||||
|
||||
## We all like making lists
|
||||
|
||||
The above header should be an H2 tag. Now, for a list of fruits:
|
||||
|
||||
- Red Apples
|
||||
- Purple Grapes
|
||||
- Green Kiwifruits
|
||||
|
||||
Let's get crazy:
|
||||
|
||||
1. This is a list item with two paragraphs. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||
mi posuere lectus.
|
||||
|
||||
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||
sit amet velit.
|
||||
|
||||
2. Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
|
||||
What about some code **in** a list? That's insane, right?
|
||||
|
||||
1. In Ruby you can map like this:
|
||||
|
||||
['a', 'b'].map { |x| x.uppercase }
|
||||
|
||||
2. In Rails, you can do a shortcut:
|
||||
|
||||
['a', 'b'].map(&:uppercase)
|
||||
|
||||
Some people seem to like definition lists
|
||||
|
||||
## I am a robot
|
||||
|
||||
Maybe you want to print `robot` to the console 1000 times. Why not?
|
||||
|
||||
def robot_invasion
|
||||
puts("robot " * 1000)
|
||||
end
|
||||
|
||||
You see, that was formatted as code because it's been indented by four spaces.
|
||||
|
||||
How about we throw some angle braces and ampersands in there?
|
||||
|
||||
<div class="footer">
|
||||
© 2004 Foo Corporation
|
||||
</div>
|
||||
|
||||
## Set in stone
|
||||
|
||||
Preformatted blocks are useful for ASCII art:
|
||||
|
||||
<pre>
|
||||
,-.
|
||||
, ,-. ,-.
|
||||
/ \ ( )-( )
|
||||
\ | ,.>-( )-<
|
||||
\|,' ( )-( )
|
||||
Y ___`-' `-'
|
||||
|/__/ `-'
|
||||
|
|
||||
|
|
||||
| -hrr-
|
||||
___|_____________
|
||||
</pre>
|
||||
|
||||
## Playing the blame game
|
||||
|
||||
If you need to blame someone, the best way to do so is by quoting them:
|
||||
|
||||
> I, at any rate, am convinced that He does not throw dice.
|
||||
|
||||
Or perhaps someone a little less eloquent:
|
||||
|
||||
> I wish you'd have given me this written question ahead of time so I
|
||||
> could plan for it... I'm sure something will pop into my head here in
|
||||
> the midst of this press conference, with all the pressure of trying to
|
||||
> come up with answer, but it hadn't yet...
|
||||
>
|
||||
> I don't want to sound like
|
||||
> I have made no mistakes. I'm confident I have. I just haven't - you
|
||||
> just put me under the spot here, and maybe I'm not as quick on my feet
|
||||
> as I should be in coming up with one.
|
||||
|
||||
## Table for two
|
||||
|
||||
| ID | Name | Rank |
|
||||
| --- | :----------------: | ----------------: |
|
||||
| 1 | Tom Preston-Werner | Awesome |
|
||||
| 2 | Albert Einstein | Nearly as awesome |
|
||||
|
||||
## Crazy linking action
|
||||
|
||||
I get 10 times more traffic from [Google][1] than from
|
||||
[Yahoo][2] or [MSN][3].
|
||||
|
||||
[1]: http://google.com/ "Google"
|
||||
[2]: http://search.yahoo.com/ "Yahoo Search"
|
||||
[3]: http://search.msn.com/ "MSN Search"
|
||||
|
||||
## Images
|
||||
|
||||
Here's an image.
|
||||
|
||||
|
||||
|
||||
Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image.
|
||||
|
||||
_View the [source of this content](https://github.com/dauxio/daux.io/blob/master/docs/01_Features/CommonMark_compliant.md)._
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
As you can see on the top of this page, you can add "Edit on Github" links to your pages, this feature can be enabled with a single parameter.
|
||||
|
||||
The value has to be the path to the root of your documentation folder in your repository.
|
||||
|
||||
In the value you see below, Daux's documentation is in the `docs` folder in the `master` branch.
|
||||
|
||||
Daux.io will handle the rest
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"edit_on_github": "dauxio/daux.io/blob/master/docs"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Edit on other VCS
|
||||
|
||||
While GitHub is the most popular, it isn't the only, collaborative VCS out there.
|
||||
|
||||
As long as you can refer your files by a URL, you can create an edit link for your VCS with the following configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"edit_on": {
|
||||
"name": "Bitbucket",
|
||||
"basepath": "https://bitbucket.org/dauxio/daux.io/src/master/docs"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
description: With Front Matter you can customize your pages even further.
|
||||
keywords: "Front Matter, Customize, Title, Description, Keywords, Author"
|
||||
author: Daux.io Team
|
||||
---
|
||||
|
||||
To customize your pages even further, you can add a Front Matter to your files.
|
||||
|
||||
Front Matter is a block you add at the top of your file and looks like this:
|
||||
|
||||
---
|
||||
title: Hallo Welt
|
||||
keywords: "Hallo, Hello, Welt, World, Erde, Earth"
|
||||
author: German Daux.io Team
|
||||
date: 12th December 1984
|
||||
---
|
||||
|
||||
## Changing the title
|
||||
|
||||
If your file is named "Hello_World_de.md" and your front matter is the one displayed above, you will get a page named "Hallo Welt"
|
||||
|
||||
## Search Engine Optimization
|
||||
|
||||
For a better **SEO** experience you can change the `description`, `keywords` and `author` meta tags.
|
||||
|
||||
## For Developers
|
||||
|
||||
You can then access this information in each `Content` with `$content->getAttributes()` or with `$page['attributes']` in a template.
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
You can create links from a page to an other, the link is then resolved to the real page.
|
||||
|
||||
Each relative link in your pages will be resolved to a page or content within the documentation.
|
||||
If the link's destination isn't found, the page generation will fail.
|
||||
|
||||
Any valid markdown link is a valid Daux.io link.
|
||||
|
||||
If your file structure looks like this:
|
||||
|
||||
```
|
||||
├── 00_Getting_Started.md
|
||||
├── 01_Features
|
||||
│ ├── CommonMark_compliant.md
|
||||
├── 02_Examples
|
||||
│ ├── Hello_World.md
|
||||
│ ├── 05_Code_Highlighting.md
|
||||
```
|
||||
|
||||
From the page `01_Features/CommonMark_compliant.md`, all the following links would be valid:
|
||||
|
||||
[Getting Started](../00_Getting_Started.md)
|
||||
[Getting Started](../00_Getting_Started.html)
|
||||
[Getting Started](../00_Getting_Started)
|
||||
[Getting Started](../Getting_Started)
|
||||
|
||||
// A link starting with / means root of the documentation, not the server it will be served from.
|
||||
[Getting Started](/Getting_Started.html)
|
||||
[Getting Started](/Getting_Started)
|
||||
|
||||
// These Will first be searched for in the current directory and then start at the root of the documentation
|
||||
[Getting Started](Getting_Started)
|
||||
[Getting Started](00_Getting_Started)
|
||||
|
||||
[Hello World](../02_Examples/Hello_World.md)
|
||||
[Hello World](../02_Examples/Hello_World.html)
|
||||
[Hello World](../02_Examples/Hello_World)
|
||||
[Hello World](../Examples/Hello_World)
|
||||
[Hello World](/02_Examples/Hello_World.md)
|
||||
[Hello World](Examples/Hello_World)
|
||||
[Hello World](02_Examples/Hello_World)
|
||||
|
||||
## Github publishing
|
||||
|
||||
If you plan to publish your documentation on Github along with your source code, we recommend to only use relative links with full names.
|
||||
|
||||
From the list of links above only these two will work both on Github and on Daux.io
|
||||
|
||||
[Getting Started](../00_Getting_Started.md)
|
||||
[Hello World](../02_Examples/Hello_World.md)
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
If you want to create a beautiful landing page for your project, create a `_index.md` file in the root of the `/docs` folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"image": "app.png"
|
||||
}
|
||||
```
|
||||
|
||||
> The image can be a local or remote image. By default, the path is relative to the root of the documentation.
|
||||
|
||||
To disable the automatic landing page, you can set `auto_landing` to false in the `html` section of your configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"auto_landing": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
Keep in mind, this mode can be used for production, but it is not recommended.
|
||||
|
||||
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.
|
||||
|
||||
## Running Locally
|
||||
|
||||
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>.
|
||||
|
||||
The easiest is to use PHP's built-in server.
|
||||
|
||||
For that i've included a short command, run `daux serve` 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>
|
||||
|
||||
## Running Remotely
|
||||
|
||||
### Clean URLs configuration
|
||||
|
||||
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 `config.json` file in the `/docs` folder.
|
||||
|
||||
```json
|
||||
{
|
||||
"live": {
|
||||
"clean_urls": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Apache
|
||||
|
||||
Copy the files from the repo to a web server that can run PHP 7.2.0 or newer.
|
||||
|
||||
There is an included `.htaccess` for Apache web server.
|
||||
|
||||
### Nginx
|
||||
|
||||
Daux.io works perfectly fine on Nginx too, just drop this configuration in your `nginx.conf`
|
||||
|
||||
```
|
||||
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;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## IIS
|
||||
|
||||
If you have set up a local or remote IIS web site, you may need a `web.config` with:
|
||||
|
||||
- A rewrite configuration, for handling clean urls.
|
||||
- A mime type handler for less files, if using a custom theme.
|
||||
|
||||
### Clean URLs
|
||||
|
||||
The `web.config` needs an entry for `<rewrite>` under `<system.webServer>`:
|
||||
|
||||
```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>
|
||||
```
|
||||
|
||||
To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as [URL Rewriter](http://urlrewriter.net/).
|
||||
|
||||
## Docker
|
||||
|
||||
This is not meant for production use, but you can bundle your documentation in Daux's docker container
|
||||
|
||||
```
|
||||
FROM daux/daux.io
|
||||
|
||||
WORKDIR /daux/
|
||||
COPY docs/ /daux/docs/
|
||||
|
||||
EXPOSE 80
|
||||
ENTRYPOINT [ "php", "-S", "0.0.0.0:80", "index.php" ]
|
||||
```
|
||||
|
||||
When you add this to a `Dockerfile` and run `docker build --name my-daux-doc .` and then `docker --rm run -p 8000:80 my-daux-doc`
|
||||
|
||||
You can access your documentation at `localhost:8000`
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
You can handle multiple languages in your documentation, each with it's own navigation.
|
||||
|
||||
Add this to your config.json :
|
||||
|
||||
```json
|
||||
{
|
||||
"languages": { "en": "English", "de": "German" }
|
||||
}
|
||||
```
|
||||
|
||||
You will the need separate directories for each language in `docs/` folder.
|
||||
|
||||
```
|
||||
├── 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
|
||||
```
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
Daux.io is extendable and comes by default with three export formats:
|
||||
|
||||
- Export to HTML
|
||||
- Export all documentation in a single HTML page
|
||||
- Upload to your Atlassian Confluence server
|
||||
|
||||
## Feature Matrix
|
||||
|
||||
| Feature | HTML | Single Page HTML | Confluence |
|
||||
| -----------------------: | :--: | :--------------: | :-------------------------: |
|
||||
| Multilanguage | √ | X (Planned) | X |
|
||||
| Landing Pages | √ | X | X |
|
||||
| Index Pages | √ | √ | √ |
|
||||
| Internal Links | √ | X (Planned) | √ |
|
||||
| Code Highlight | √ | X (Planned) | √ (Using macros) |
|
||||
| Live Mode | √ | X | X |
|
||||
| Pages Ordering | √ | √ | X (API Limitation) |
|
||||
| Google / Piwik analytics | √ | √ | √ (Configured on Conflence) |
|
||||
|
||||
## Confluence Example
|
||||
|
||||
You can see this documentation uploaded to Confluence : https://dauxio.atlassian.net/wiki/spaces/DOC/overview
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
## Navigation
|
||||
|
||||
The navigation is generated automatically with all pages that end with `.md` or `.markdown`
|
||||
|
||||
You can have as many sub levels as you wish.
|
||||
|
||||
By default, a folder will have no index page.
|
||||
if you wish to have one defined all you need to do is add an `index.md` file to the folder.
|
||||
For example, `/docs/02_Examples` has a landing page for that section since there exists a `/docs/02_Examples/index.md` file.
|
||||
|
||||
## Sorting
|
||||
|
||||
To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md`.
|
||||
This will list _Hello World_ before _Features_, overriding the default alpha-numeric sorting.
|
||||
The numbers will be stripped out of the navigation and urls. For the file `6 Ways to Get Rich`, you can use `/docs/_6_Ways_to_Get_Rich.md`
|
||||
|
||||
You might also wish to stick certain links to the bottom of a page.
|
||||
You can do so by prefixing the file name with a '-', e.g. a new file `/docs/-Contact_Us.md` will always appear at the bottom of the current list.
|
||||
Weights can also be added to further sort the bottom entries. e.g. `/docs/-01_Coming.md` will appear before `/docs/-02_Soon.md` but both will only appear after all positive or non-weighted files.
|
||||
|
||||
It works the same for files prefixed with `+`.
|
||||
|
||||
Page order priorities are like this:
|
||||
|
||||
- `+` in front of the filename and numbers in front
|
||||
- `+` in front of the filename
|
||||
- The index page
|
||||
- Numbers in the front
|
||||
- Pages without prefix
|
||||
- `-` in front of the filename and numbers in front
|
||||
- `-` in front of the filename
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
Searching in a Daux.io documentation is possible, but only in static mode.
|
||||
|
||||
We don't provide this feature in live rendering as it would be too slow.
|
||||
|
||||
To enable the generated search, you can set `search` to true in the `html` section of your configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"search": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
If you don't want to serve the live version of your site, you can also generate files, these can be one of the three supported formats :
|
||||
|
||||
- HTML output
|
||||
- Single page HTML output
|
||||
- Atlassian Confluence upload
|
||||
|
||||
Generating a complete set of pages, with navigation
|
||||
|
||||
```bash
|
||||
daux --destination=[Output Directory Relative Direction]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
For more options, run
|
||||
|
||||
```bash
|
||||
daux generate --help
|
||||
```
|
||||
|
||||
### Specify the configuration file
|
||||
|
||||
### Specify the format
|
||||
|
||||
Valid options are `html`, `confluence` or `html-file`.
|
||||
You can also add your own formats through Processors
|
||||
|
||||
```bash
|
||||
daux --format=html
|
||||
```
|
||||
|
||||
### Specify a processor
|
||||
|
||||
A processor can be specified through the `--processor` option, this should be the name of a class inside the `Todaymade\Daux\Extension` namespace.
|
||||
|
||||
By running :
|
||||
|
||||
```bash
|
||||
daux --processor=Processor
|
||||
```
|
||||
|
||||
Daux will be looking for `Todaymade\Daux\Extension\Processor` inside the `daux` folder.
|
||||
|
||||
You can try to run this command, we added a small example Processor.
|
||||
|
||||
### Specify the source
|
||||
|
||||
By default, the source is taken from the `docs_directory` configuration value in `global.json` but you can override it here.
|
||||
|
||||
```bash
|
||||
daux --source=docs_to_generate
|
||||
```
|
||||
|
||||
The path can be absolute or relative
|
||||
|
||||
### Specify the destination
|
||||
|
||||
By default the destination is `static`
|
||||
|
||||
```bash
|
||||
daux --destination=generated_docs
|
||||
```
|
||||
|
||||
The path can be absolute or relative
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
Adding a table of contents becomes very easy with Daux.io
|
||||
|
||||
## Manual
|
||||
|
||||
Add `[TOC]` anywhere in your document and it will be replaced by a table of contents.
|
||||
|
||||
You can add it more than once in a page.
|
||||
|
||||
## Automatic
|
||||
|
||||
> Works only for html mode
|
||||
|
||||
A table of contents can be added automatically to all pages.
|
||||
|
||||
If `[TOC]` isn't present it will add it at the beginning of the page.
|
||||
|
||||
You can enable this feature in your configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"auto_toc": true
|
||||
}
|
||||
}
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,2 +0,0 @@
|
|||
This is just another sample page to get you started. What do you think ?
|
||||
测试一下
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
title: Hallo Welt
|
||||
date: 12th December 1984
|
||||
---
|
||||
|
||||
This is a page which has attributes and a overriden Title
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
### This is a landing page for the Examples section
|
||||
|
||||
Adding a landing page is pretty simple, all you need to do is add an "index.md" file to the related folder.
|
||||
|
|
@ -1 +0,0 @@
|
|||
We also support UTF-8 file names
|
||||
|
|
@ -1 +0,0 @@
|
|||
Even more UTF-8 file names !
|
||||
|
|
@ -1,98 +0,0 @@
|
|||
**Table of contents**
|
||||
|
||||
[TOC]
|
||||
|
||||
## Configuring the connection
|
||||
|
||||
The connection requires three parameters `base_url`, `user` and `pass`. While `user` and `pass` don't really need an explanation, for `base_url` you need to set the path to the server without `rest/api`, this will be added automatically.
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": {
|
||||
"base_url": "http://my_confluence_server.com/",
|
||||
"user": "my_username",
|
||||
"pass": "my_password"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Where to upload
|
||||
|
||||
Now that the connection is defined, you need to tell it where you want your documentation to be uploaded.
|
||||
|
||||
For that you need a `space_id` (name that appears at the beginning of the urls) and an `ancestor_id`; the id of the page that will be the parent of the documentation's homepage.
|
||||
|
||||
You can obtain the `ancestor_id` id by editing the page you want to define as a parent: the ID is at the end of the URL
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": {
|
||||
"space_id": "my_space",
|
||||
"ancestor_id": 50370632
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can also provide a `root_id` instead of an `ancestor_id` in this case, you specify the id as the homepage of your documentation.
|
||||
|
||||
You can use that when you're uploading your documentation to the root of a Confluence Space or if your page already exists.
|
||||
|
||||
## Prefix
|
||||
|
||||
Because confluence can't have two pages with the same name in a space, I recommend you define a prefix for your pages.
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": { "prefix": "DAUX -" }
|
||||
}
|
||||
```
|
||||
|
||||
## Update threshold
|
||||
|
||||
To make the upload quicker, we try to determine if a page changed or not, first with a strict comparison and if it's not completely identical, we compute the difference.
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": { "update_threshold": 1 }
|
||||
}
|
||||
```
|
||||
|
||||
If you set `update_threshold` to 1, it will upload only if the page has more than 1% difference with the previous one.
|
||||
|
||||
By default the threshold is 2%.
|
||||
|
||||
Setting the value to `0` disables the feature altogether.
|
||||
|
||||
## Delete old pages
|
||||
|
||||
When a page is renamed, there is no way to tell it was renamed, so when uploading to Confluence, the page will be uploaded and the old page will stay here.
|
||||
|
||||
By default, it will inform you that some pages aren't needed anymore and you can delete them by hand.
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": { "delete": true }
|
||||
}
|
||||
```
|
||||
|
||||
By setting `delete` to `true` (or running `daux` with the `--delete` flag) you tell the generator that it can safely delete the pages.
|
||||
|
||||
## Information message
|
||||
|
||||
When you create your page. there is no indication that the upload process will override the content of the pages.
|
||||
|
||||
It happens sometimes that users edit the pages to add / fix an information.
|
||||
|
||||
You can add a text in a "information" macro on top of the document by setting the following configuration :
|
||||
|
||||
```json
|
||||
{
|
||||
"confluence": {
|
||||
"header": "These pages are updated automatically, your changes will be overriden."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
It will look like this :
|
||||
|
||||
|
||||
|
|
@ -1,185 +0,0 @@
|
|||
**Table of contents**
|
||||
|
||||
[TOC]
|
||||
|
||||
## Analytics
|
||||
|
||||
### Google Analytics
|
||||
|
||||
This will embed the google analytics tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "google_analytics": "UA-XXXXXXXXX-XX" }
|
||||
}
|
||||
```
|
||||
|
||||
### Piwik Analytics
|
||||
|
||||
This will embed the piwik tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "piwik_analytics": "my-url-for-piwik.com" }
|
||||
}
|
||||
```
|
||||
|
||||
You can Also give a specific Piwik ID as well.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "piwik_analytics_id": "43" }
|
||||
}
|
||||
```
|
||||
|
||||
### Plausible Analytics
|
||||
|
||||
This will embed the https://plausible.io/ tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "plausible_domain": "daux.io" }
|
||||
}
|
||||
```
|
||||
|
||||
## Automatic Table of Contents
|
||||
|
||||
You can add a table of contents on each page automatically, read about it [here](../01_Features/Table_of_contents.md)
|
||||
|
||||
## Buttons
|
||||
|
||||
You can add buttons to the landing page.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"buttons": {
|
||||
"My Website": "http://example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Breadcrumb titles
|
||||
|
||||
Daux.io provides the option to present page titles as breadcrumb navigation.
|
||||
You can _optionally_ specify the separator used for breadcrumbs.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"breadcrumbs": true,
|
||||
"breadcrumb_separator": " > "
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Date Modified
|
||||
|
||||
By default, daux.io will display the last modified time as reported by the system underneath the title for each document.
|
||||
To disable this, change the option in your config.json to `false`.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "date_modified": false }
|
||||
}
|
||||
```
|
||||
|
||||
## GitHub Repo
|
||||
|
||||
Add a 'Fork me on GitHub' ribbon.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "repo": "dauxio/daux.io" }
|
||||
}
|
||||
```
|
||||
|
||||
## Inherit Index
|
||||
|
||||
This feature will instructs the navigation generator to seek the first available file to use when there is no index in a folder.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "inherit_index": true }
|
||||
}
|
||||
```
|
||||
|
||||
## Jump buttons
|
||||
|
||||
You can have previous/next buttons on each page.
|
||||
They can be disabled by setting `jump_buttons` to `false`.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "jump_buttons": false }
|
||||
}
|
||||
```
|
||||
|
||||
## Landing page
|
||||
|
||||
The automatic landing page can be disabled through the `auto_landing` option, read about it [here](../01_Features/Landing_page.md)
|
||||
|
||||
## Links
|
||||
|
||||
Include custom links in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": {
|
||||
"links": {
|
||||
"GitHub Repo": "https://github.com/dauxio/daux.io",
|
||||
"Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues",
|
||||
"Made by Todaymade": "http://todaymade.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Search
|
||||
|
||||
Daux has an embedded search engine read all about it [here](../01_Features/Search.md)
|
||||
|
||||
## Themes
|
||||
|
||||
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
|
||||
|
||||
- daux-blue
|
||||
- daux-green
|
||||
- daux-navy
|
||||
- daux-red
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "theme": "daux-blue" }
|
||||
}
|
||||
```
|
||||
|
||||
To use a custom theme, just copy over the theme folder into the `themes` directory and set its value in the `theme` param in `config.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "theme": "new-theme" }
|
||||
}
|
||||
```
|
||||
|
||||
## Toggling Code Blocks
|
||||
|
||||
Some users might wish to hide the code blocks & view just the documentation.
|
||||
By setting the `toggle_code` property to `true`, you can offer a toggle button on the page.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "toggle_code": true }
|
||||
}
|
||||
```
|
||||
|
||||
## Twitter
|
||||
|
||||
Include twitter follow buttons in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"html": { "twitter": ["justin_walsh", "todaymade"] }
|
||||
}
|
||||
```
|
||||
|
|
@ -1,160 +0,0 @@
|
|||
To customize the look and feel of your documentation, you can create a `config.json` file in the of the `/docs` folder. The `config.json` file is a JSON object that you can use to change some of the basic settings of the documentation.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
[TOC]
|
||||
|
||||
### Title
|
||||
|
||||
Change the title bar in the docs
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
### Tagline
|
||||
|
||||
Change the tagline bar in the docs
|
||||
|
||||
```json
|
||||
{
|
||||
"tagline": "The Easiest Way To Document Your Project"
|
||||
}
|
||||
```
|
||||
|
||||
### Author
|
||||
|
||||
Change the documentation's author
|
||||
|
||||
```json
|
||||
{
|
||||
"author": "Stéphane Goetz"
|
||||
}
|
||||
```
|
||||
|
||||
### Image
|
||||
|
||||
An image to show on the landing page. A relative path from the documentation root.
|
||||
|
||||
```json
|
||||
{
|
||||
"image": "image.png"
|
||||
}
|
||||
```
|
||||
|
||||
### Format
|
||||
|
||||
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
|
||||
|
||||
```json
|
||||
{
|
||||
"format": "html"
|
||||
}
|
||||
```
|
||||
|
||||
- **html** with [its options](./Html_export.md)
|
||||
- **confluence** with [its options](./Confluence_upload.md)
|
||||
|
||||
Available formats are **HTML** and **Confluence**
|
||||
|
||||
### Ignore
|
||||
|
||||
Set custom files and entire folders to ignore within your `/docs` folder. For files make sure to include the file extension in the name. For both files and folders, names are case-sensitive.
|
||||
|
||||
```json
|
||||
{
|
||||
"ignore": {
|
||||
"files": ["Work_In_Progress.md"],
|
||||
"folders": ["99_Not_Ready"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Timezone
|
||||
|
||||
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 [PHP Manual](http://php.net/manual/en/timezones.php).
|
||||
|
||||
```json
|
||||
{
|
||||
"timezone": "America/Los_Angeles"
|
||||
}
|
||||
```
|
||||
|
||||
### Multi-language
|
||||
|
||||
Enables multi-language support which needs separate directories for each language in `docs/` folder.
|
||||
|
||||
```json
|
||||
{
|
||||
"languages": { "en": "English", "de": "German" }
|
||||
}
|
||||
```
|
||||
|
||||
Directory structure:
|
||||
|
||||
```
|
||||
├── 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
|
||||
```
|
||||
|
||||
### Language
|
||||
|
||||
You can change the default language with the `language` option.
|
||||
|
||||
```json
|
||||
{
|
||||
"language": "fr"
|
||||
}
|
||||
```
|
||||
|
||||
This will change the language of the text within Daux.io and also the `<html lang>` attribute.
|
||||
|
||||
You can override the translations with the `strings` option.
|
||||
A string that isn't found will fall back to english.
|
||||
|
||||
```json
|
||||
{
|
||||
"strings": {
|
||||
"fr": {
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Processor
|
||||
|
||||
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.
|
||||
|
||||
More information on how to create a Processor can be found [here](!For_Developers/Creating_a_Processor).
|
||||
|
||||
```json
|
||||
{
|
||||
"processor": "MyProcessor"
|
||||
}
|
||||
```
|
||||
|
|
@ -1,94 +0,0 @@
|
|||
The recommended way to extend Daux is through Processors.
|
||||
|
||||
The main advantage, is that you can run it with the source or with `daux` independently. You don't need to hack in the core.
|
||||
|
||||
## Adding classes
|
||||
|
||||
Next to your `docs` directory, you can create a `daux` directory that can contain your Processor.
|
||||
|
||||
The classes must respect the PSR-4 Naming convention. And have `\Todaymade\Daux\Extension` as a base namespace.
|
||||
|
||||
By default, we created a `daux/Processor.php` file to get you started.
|
||||
|
||||
## A quick test ?
|
||||
|
||||
For the example we're just going to dump the tree and exit.
|
||||
|
||||
```php
|
||||
public function manipulateTree(Root $root)
|
||||
{
|
||||
print_r($root->dump());
|
||||
exit;
|
||||
}
|
||||
```
|
||||
|
||||
also, add this at the beginning of the file:
|
||||
|
||||
```php
|
||||
use Todaymade\Daux\Tree\Root;
|
||||
```
|
||||
|
||||
Let's just try if it works by running `daux --processor=Processor`
|
||||
|
||||
Yes, you get a big array dump! You're good to go.
|
||||
|
||||
## What can I achieve ?
|
||||
|
||||
There are a few methods that you can override to add some
|
||||
|
||||
### Change the parsed tree.
|
||||
|
||||
By default, Daux.io parses your directory to find pages. but, for a reason or another, you might want to programmatically add some pages.
|
||||
|
||||
This can be done with:
|
||||
|
||||
```php
|
||||
public function manipulateTree(Root $root)
|
||||
{
|
||||
}
|
||||
```
|
||||
|
||||
Two helpers from the class `Todaymade\Daux\Tree\Builder` will greatly help you doing that:
|
||||
|
||||
```php
|
||||
$new = Builder::getOrCreateDir($root, 'New Pages');
|
||||
|
||||
$page = Builder::getOrCreatePage($new, 'index');
|
||||
$page->setContent('The index page for the new folder');
|
||||
|
||||
$page = Builder::getOrCreatePage($new, 'A New Hope');
|
||||
$page->setContent('A long time ago in a galaxy far away');
|
||||
```
|
||||
|
||||
Both methods `getOrCreateDir` and `getOrCreatePage` take two parameters : `parent` and `title`
|
||||
|
||||
The page will automatically be treated as markdown and converted like a normal page.
|
||||
|
||||
If you create a new ContentType, like let's say LaTeX, you would set the title `My Page.tex` it will keep the title `My Page` and use your renderer.
|
||||
|
||||
If the extension is not mapped to a Generator, it will simply create the file as-is without manipulation.
|
||||
|
||||
### Extend the Markdown Generator
|
||||
|
||||
You can extend the Markdown Parser in any way wou want with this method.
|
||||
|
||||
```php
|
||||
public function extendCommonMarkEnvironment(Environment $environment)
|
||||
{
|
||||
}
|
||||
```
|
||||
|
||||
See the details on [CommonMark's website](http://commonmark.thephpleague.com/customization/overview/).
|
||||
|
||||
### Add new generators
|
||||
|
||||
You can add new generators to Daux.io and use them right away, they must implement the
|
||||
`\Todaymade\Daux\Format\Base\Generator` interface and if you want to use the live mode with your generator
|
||||
you have to implement `\Todaymade\Daux\Format\Base\LiveGenerator`.
|
||||
|
||||
```php
|
||||
public function addGenerators()
|
||||
{
|
||||
return ['custom_generator' => '\Todaymade\Daux\Extension\MyNewGenerator'];
|
||||
}
|
||||
```
|
||||
|
|
@ -1,103 +0,0 @@
|
|||
In its simplest form, a theme is an empty folder with a `config.json` file containing `{}`
|
||||
|
||||
After that, every setting is optional, but you can override everything if you'd like to.
|
||||
|
||||
> **Overriding styles**
|
||||
>
|
||||
> If you want to tweak a few styles, you can create a `style.css` file at the root of your documentation
|
||||
> directory and it will be included automatically. By doing this, you don't need to create a new theme.
|
||||
|
||||
## `config.json` options
|
||||
|
||||
Here is an example `config.json` file :
|
||||
|
||||
```json
|
||||
{
|
||||
"favicon": "<theme_url>img/favicon.png",
|
||||
"css": ["<theme_url>css/theme.min.css"],
|
||||
"js": [],
|
||||
"fonts": [
|
||||
"https://fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic"
|
||||
],
|
||||
"variants": {
|
||||
"blue": {
|
||||
"favicon": "<theme_url>img/favicon-blue.png",
|
||||
"css": ["<theme_url>css/theme-blue.min.css"]
|
||||
},
|
||||
"green": {
|
||||
"favicon": "<theme_url>img/favicon-green.png",
|
||||
"css": ["<theme_url>css/theme-green.min.css"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
There are five options :
|
||||
|
||||
- **`favicon`**: The URL to your favicon
|
||||
- **`css`**: An array of CSS Stylesheets to add to the page
|
||||
- **`js`**: An array of JavaScript files to load
|
||||
- **`fonts`**: An array of Font sources, these are added as stylesheets
|
||||
- **`variants`**: An object containing sub-themes. Each sub theme, can provide the same configurations as the main theme (`favicon`, `css`, `js`, `fonts`)
|
||||
|
||||
You will also notice this `<theme_url>` in the url.
|
||||
This is automatically substituted with the final url to the theme when generating the final page.
|
||||
|
||||
There are two possible substitutions :
|
||||
|
||||
- **`<theme_url>`**: The url to the current theme
|
||||
- **`<base_url>`**: The url to the documentation root
|
||||
|
||||
## Theme variants
|
||||
|
||||
Like the default Daux.io theme, you might want to provide variants of your theme.
|
||||
|
||||
In the example before, there were two variants : blue and green.
|
||||
|
||||
The configuration of a variant is added to the configuration of the main theme, it doesn't replace it.
|
||||
|
||||
For example the main CSS files defined are: `["<theme_url>css/theme.min.css"]` and the green variant defines `["<theme_url>css/theme-green.min.css"]`.
|
||||
|
||||
The final list of CSS files will be `["<theme_url>css/theme.min.css", "<theme_url>css/theme-green.min.css"]`.
|
||||
|
||||
This doesn't apply to `favicon`, only the last value set is kept.
|
||||
|
||||
## Setting the theme for your documentation
|
||||
|
||||
In your documentation's `config.json` (not the theme's `config.json`)
|
||||
|
||||
Change the `theme` option inside `html`
|
||||
|
||||
```json
|
||||
{
|
||||
"themes_directory": "/home/user/themes",
|
||||
"html": {
|
||||
"theme": "{theme}-{variant}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The name of the theme, is the folder name.
|
||||
|
||||
You can use the `themes_directory` setting if you want to specify a custom location of your `themes` folder.
|
||||
|
||||
A variant is optional, if you want to add one, separate it from the theme with a dash.
|
||||
|
||||
## Overriding templates
|
||||
|
||||
By default, you have a list of templates in `templates`
|
||||
|
||||
You can create a folder named `templates` in your theme, copy-paste the original template in that folder, and you can modify it freely.
|
||||
|
||||
You can even do it one template at a time if you wish to do only small changes.
|
||||
|
||||
By default, we have the following templates :
|
||||
|
||||
- `content.php`: The content page.
|
||||
- `home.php`: The landing page.
|
||||
- `error.php`: The page to show when a page is not found or some other error happened.
|
||||
- `partials/navbar_content.php`: The content of the top navigation bar.
|
||||
- `partials/google_analytics.php`: The script to load Google Analytics.
|
||||
- `partials/piwik_analytics.php`: The script to load Piwik Analytics.
|
||||
- `layout/00_layout.php`: The master template, containing the `<html>` tag.
|
||||
- `layout/05_page.php`: The page layout, with left navigation.
|
||||
|
|
@ -1,71 +0,0 @@
|
|||
<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>
|
||||
|
||||
---
|
||||
|
||||
### Features
|
||||
|
||||
---
|
||||
|
||||
<div class="Row">
|
||||
<div class="Row__third">
|
||||
|
||||
#### For Authors
|
||||
|
||||
- [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)
|
||||
- [Internal documentation links](01_Features/Internal_links.md)
|
||||
- [CommonMark compliant](01_Features/CommonMark_compliant.md)
|
||||
- [Auto created homepage/landing page](01_Features/Landing_page.md)
|
||||
- [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)
|
||||
- [Multiple Languages Support](01_Features/Multilanguage.md)
|
||||
- [No Build Step](01_Features/Live_mode.md)
|
||||
- [Static Output Generation](01_Features/Static_Site_Generation.md)
|
||||
- [Table of Contents](01_Features/Table_of_contents.md)
|
||||
|
||||
</div>
|
||||
<div class="Row__third">
|
||||
|
||||
#### For Developers
|
||||
|
||||
- [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
|
||||
- [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
|
||||
- Full access to the internal API to create new pages programatically
|
||||
- Work with pages metadata
|
||||
|
||||
</div>
|
||||
<div class="Row__third">
|
||||
|
||||
#### For Marketing
|
||||
|
||||
- 100% Mobile Responsive
|
||||
- 4 Built-In Themes or roll your own
|
||||
- Functional, Flat Design Style
|
||||
- Optional code float layout
|
||||
- Shareable/Linkable SEO Friendly URLs
|
||||
- Supports Google Analytics and Piwik Analytics
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
### Installation and usage
|
||||
|
||||
If you have **PHP** and Composer installed
|
||||
|
||||
```bash
|
||||
composer global require daux/daux.io
|
||||
|
||||
# Next to your `docs` folder, run
|
||||
daux generate
|
||||
```
|
||||
|
||||
Or if you wish to use **Docker**
|
||||
|
||||
```bash
|
||||
# Next to your `docs` folder, run
|
||||
docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate
|
||||
```
|
||||
|
||||
---
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 81 KiB |
BIN
docs/app.png
BIN
docs/app.png
Binary file not shown.
|
Before Width: | Height: | Size: 100 KiB |
|
|
@ -1,39 +0,0 @@
|
|||
{
|
||||
"title": "DAUX.IO",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"author": "Stéphane Goetz",
|
||||
"image": "app.png",
|
||||
"ignore": {
|
||||
"files": ["Work_In_Progress.md"],
|
||||
"folders": ["99_Not_Ready"]
|
||||
},
|
||||
"live": {
|
||||
"clean_urls": true
|
||||
},
|
||||
"html": {
|
||||
"theme": "daux-blue",
|
||||
"breadcrumbs": true,
|
||||
"breadcrumb_separator": "Chevrons",
|
||||
"toggle_code": true,
|
||||
"date_modified": true,
|
||||
"inherit_index": true,
|
||||
|
||||
"repo": "dauxio/daux.io",
|
||||
"edit_on_github": "dauxio/daux.io/blob/master/docs",
|
||||
"twitter": ["onigoetz"],
|
||||
"google_analytics": false,
|
||||
"plausible_domain": false,
|
||||
"links": {
|
||||
"GitHub Repository": "https://github.com/dauxio/daux.io",
|
||||
"Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues",
|
||||
"Packagist": "https://packagist.org/packages/daux/daux.io",
|
||||
"Docker Images": "https://hub.docker.com/r/daux/daux.io"
|
||||
},
|
||||
"powered_by": "Powered by Daux.io"
|
||||
},
|
||||
"confluence": {
|
||||
"base_url": "https://dauxio.atlassian.net/wiki/",
|
||||
"space_id": "DOC",
|
||||
"root_id": 196610
|
||||
}
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
This is our landing page.
|
||||
|
||||
Welcome to this awesome multilanguage documentation.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
{
|
||||
"title": "Multilanguage Example",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
|
||||
"languages": {
|
||||
"en": "English",
|
||||
"fr": "Français"
|
||||
}
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
It starts here.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Some configuration options
|
||||
|
|
@ -1 +0,0 @@
|
|||
C'est ici que tout commence.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Quelques options de configuration
|
||||
129
global.json
129
global.json
|
|
@ -1,129 +0,0 @@
|
|||
{
|
||||
"docs_directory": "docs",
|
||||
"themes_directory": "themes",
|
||||
|
||||
"title": "My Project",
|
||||
"tagline": "My Stylish Documentation",
|
||||
"author": "I, Me & Myself",
|
||||
"image": "",
|
||||
"languages": {},
|
||||
|
||||
"cache": true,
|
||||
|
||||
"format": "html",
|
||||
"processor": "",
|
||||
|
||||
"ignore": {
|
||||
"files": [],
|
||||
"folders": []
|
||||
},
|
||||
|
||||
"language": "en",
|
||||
|
||||
"strings": {
|
||||
"en": {
|
||||
"CodeBlocks_show": "Show Code Blocks",
|
||||
"Search_placeholder": "Search...",
|
||||
"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",
|
||||
"Edit_on": "Edit on :name:",
|
||||
"View_on_github": "View On GitHub",
|
||||
"View_documentation": "View Documentation",
|
||||
"Table_of_contents": "Table of Contents",
|
||||
"Toggle_navigation": "Toggle navigation"
|
||||
},
|
||||
"fr": {
|
||||
"CodeBlocks_show": "Afficher le code",
|
||||
"Search_placeholder": "Rechercher...",
|
||||
"Search_one_result": "1 résultat",
|
||||
"Search_results": "!count résultats",
|
||||
"Search_no_results": "Aucun résultat trouvé",
|
||||
"Search_common_words_ignored": "Les mots communs sont ignorés",
|
||||
"Search_too_short": "Critère de recherche trop court",
|
||||
"Search_one_character_or_more": "Doit être un caractère ou plus",
|
||||
"Search_should_be_x_or_more": "Doit être !min caractère ou plus",
|
||||
"Link_previous": "Précédent",
|
||||
"Link_next": "Suivant",
|
||||
"Edit_on": "Editer sur :name:",
|
||||
"View_on_github": "Voir sur GitHub",
|
||||
"View_documentation": "Voir la Documentation",
|
||||
"Table_of_contents": "Table des matières"
|
||||
},
|
||||
"de": {
|
||||
"CodeBlocks_show": "Code-Blöcke anzeigen",
|
||||
"Search_placeholder": "Suchen...",
|
||||
"Search_one_result": "1 Ergebnis",
|
||||
"Search_results": "!count Ergebnisse",
|
||||
"Search_no_results": "Nichts gefunden",
|
||||
"Search_common_words_ignored": "Allgemeine Wörter werden weitgehend ignoriert",
|
||||
"Search_too_short": "Suche zu kurz",
|
||||
"Search_one_character_or_more": "Sollte ein Zeichen oder mehr sein",
|
||||
"Search_should_be_x_or_more": "Sollte !min Zeichen oder mehr sein",
|
||||
"Link_previous": "Zurück",
|
||||
"Link_next": "Weiter",
|
||||
"Edit_on": "Bearbeiten bei :name:",
|
||||
"View_on_github": "Bei GitHub anzeigen",
|
||||
"View_documentation": "Dokumentation anzeigen",
|
||||
"Table_of_contents": "Inhaltsverzeichnis"
|
||||
},
|
||||
"it": {
|
||||
"CodeBlocks_show": "Mostra blocchi di codice",
|
||||
"Search_one_result": "1 risultato",
|
||||
"Search_results": "!count risultati",
|
||||
"Search_no_results": "Nessun risultato trovato",
|
||||
"Search_common_words_ignored": "Le parole comuni vengono per lo più ignorate",
|
||||
"Search_too_short": "Ricerca troppo breve",
|
||||
"Search_one_character_or_more": "Dovrebbe essere composto da uno o più caratteri",
|
||||
"Search_should_be_x_or_more": "Dovrebbe essere composto da almeno !min caratteri",
|
||||
"Search_placeholder": "Cerca...",
|
||||
"Link_previous": "Pagina precedente",
|
||||
"Link_next": "Pagina successiva",
|
||||
"Edit_on": "Modifica su :name:",
|
||||
"View_on_github": "Guarda su GitHub",
|
||||
"View_documentation": "Leggi la documentazione",
|
||||
"Table_of_contents": "Contenuti"
|
||||
}
|
||||
},
|
||||
|
||||
"timezone": "America/Los_Angeles",
|
||||
|
||||
"live": {
|
||||
"clean_urls": true
|
||||
},
|
||||
|
||||
"html": {
|
||||
"theme": "daux-blue",
|
||||
"breadcrumbs": true,
|
||||
"breadcrumb_separator": "Chevrons",
|
||||
"toggle_code": true,
|
||||
"date_modified": false,
|
||||
"auto_landing": true,
|
||||
"search": true,
|
||||
"auto_toc": false,
|
||||
"inherit_index": false,
|
||||
"jump_buttons": true,
|
||||
|
||||
"repo": "",
|
||||
"twitter": [],
|
||||
"links": {
|
||||
},
|
||||
"buttons": {
|
||||
},
|
||||
|
||||
"google_analytics": false,
|
||||
"piwik_analytics": false,
|
||||
"piwik_analytics_id": "0"
|
||||
},
|
||||
|
||||
"confluence": {
|
||||
"prefix": "",
|
||||
"delete": false
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,196 @@
|
|||
<!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>
|
||||
80
index.php
80
index.php
|
|
@ -1,80 +0,0 @@
|
|||
<?php
|
||||
/*
|
||||
|
||||
Daux.io
|
||||
==================
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This is a tool for auto-generating documentation based on markdown files
|
||||
located in the /docs folder of the project. To see all of the available
|
||||
options and to read more about how to use the generator, visit:
|
||||
|
||||
https://dauxio.github.io/
|
||||
|
||||
|
||||
Author
|
||||
------
|
||||
Justin Walsh (Todaymade): justin@todaymade.com, @justin_walsh
|
||||
Garrett Moon (Todaymade): garrett@todaymade.com, @garrett_moon
|
||||
|
||||
|
||||
Feedback & Suggestions
|
||||
----
|
||||
|
||||
To give us feedback or to suggest an idea, please create an request on the the
|
||||
GitHub issue tracker:
|
||||
|
||||
https://github.com/dauxio/daux.io/issues
|
||||
|
||||
Bugs
|
||||
----
|
||||
|
||||
To file bug reports please create an issue using the github issue tracker:
|
||||
|
||||
https://github.com/dauxio/daux.io/issues
|
||||
|
||||
|
||||
Copyright and License
|
||||
---------------------
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
This software is provided by the copyright holders and contributors "as
|
||||
is" and any express or implied warranties, including, but not limited
|
||||
to, the implied warranties of merchantability and fitness for a
|
||||
particular purpose are disclaimed. In no event shall the copyright owner
|
||||
or contributors be liable for any direct, indirect, incidental, special,
|
||||
exemplary, or consequential damages (including, but not limited to,
|
||||
procurement of substitute goods or services; loss of use, data, or
|
||||
profits; or business interruption) however caused and on any theory of
|
||||
liability, whether in contract, strict liability, or tort (including
|
||||
negligence or otherwise) arising in any way out of the use of this
|
||||
software, even if advised of the possibility of such damage.
|
||||
|
||||
*/
|
||||
|
||||
if (php_sapi_name() === 'cli-server') {
|
||||
// This file allows us to emulate Apache's "mod_rewrite"
|
||||
// functionality from the built-in PHP web server.
|
||||
$uri = urldecode(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
|
||||
if ($uri !== '/' && file_exists(__DIR__ . $uri)) {
|
||||
return false;
|
||||
}
|
||||
// When the built in server is used
|
||||
// the script name is the file called
|
||||
$_SERVER['SCRIPT_NAME'] = '/index.php';
|
||||
}
|
||||
|
||||
require_once __DIR__ . '/libs/bootstrap.php';
|
||||
|
||||
\Todaymade\Daux\Server\Server::serve();
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
<?php namespace Todaymade\Daux;
|
||||
|
||||
use ArrayObject;
|
||||
|
||||
class BaseConfig extends ArrayObject
|
||||
{
|
||||
/**
|
||||
* Merge an array into the object.
|
||||
*
|
||||
* @param array $newValues
|
||||
* @param bool $override
|
||||
*/
|
||||
public function merge($newValues, $override = true)
|
||||
{
|
||||
foreach ($newValues as $key => $value) {
|
||||
// If the key doesn't exist yet,
|
||||
// we can simply set it.
|
||||
if (!array_key_exists($key, (array) $this)) {
|
||||
$this[$key] = $value;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// We already know this value exists
|
||||
// so if we're in conservative mode
|
||||
// we can skip this key
|
||||
if ($override === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Merge the values only if
|
||||
// both values are arrays
|
||||
if (is_array($this[$key]) && is_array($value)) {
|
||||
$this[$key] = array_replace_recursive($this[$key], $value);
|
||||
} else {
|
||||
$this[$key] = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function hasValue($key)
|
||||
{
|
||||
return array_key_exists($key, (array) $this);
|
||||
}
|
||||
|
||||
public function getValue($key)
|
||||
{
|
||||
return $this[$key];
|
||||
}
|
||||
|
||||
public function setValue($key, $value)
|
||||
{
|
||||
$this[$key] = $value;
|
||||
}
|
||||
}
|
||||
103
libs/Cache.php
103
libs/Cache.php
|
|
@ -1,103 +0,0 @@
|
|||
<?php namespace Todaymade\Daux;
|
||||
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class Cache
|
||||
{
|
||||
public static $printed = false;
|
||||
|
||||
public static function getDirectory(): string
|
||||
{
|
||||
$dir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'dauxio' . DIRECTORY_SEPARATOR;
|
||||
|
||||
if (!Cache::$printed) {
|
||||
Cache::$printed = true;
|
||||
Daux::writeln("Using cache dir '$dir'", OutputInterface::VERBOSITY_VERBOSE);
|
||||
}
|
||||
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Store an item in the cache for a given number of minutes.
|
||||
*/
|
||||
public static function put(string $key, string $value): void
|
||||
{
|
||||
Cache::ensureCacheDirectoryExists($path = Cache::path($key));
|
||||
file_put_contents($path, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the file cache directory if necessary.
|
||||
*/
|
||||
protected static function ensureCacheDirectoryExists(string $path): void
|
||||
{
|
||||
$parent = dirname($path);
|
||||
|
||||
if (!file_exists($parent)) {
|
||||
mkdir($parent, 0777, true);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove an item from the cache.
|
||||
*/
|
||||
public static function forget(string $key): bool
|
||||
{
|
||||
$path = Cache::path($key);
|
||||
|
||||
if (file_exists($path)) {
|
||||
return unlink($path);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an item from the cache by key.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public static function get(string $key): ?string
|
||||
{
|
||||
$path = Cache::path($key);
|
||||
|
||||
if (file_exists($path)) {
|
||||
return file_get_contents($path);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the full path for the given cache key.
|
||||
*/
|
||||
protected static function path(string $key): string
|
||||
{
|
||||
$parts = array_slice(str_split($hash = sha1($key), 2), 0, 2);
|
||||
|
||||
return Cache::getDirectory() . '/' . implode('/', $parts) . '/' . $hash;
|
||||
}
|
||||
|
||||
public static function clear(): void
|
||||
{
|
||||
Cache::rrmdir(Cache::getDirectory());
|
||||
}
|
||||
|
||||
protected static function rrmdir(string $dir): void
|
||||
{
|
||||
if (is_dir($dir)) {
|
||||
$objects = scandir($dir);
|
||||
foreach ($objects as $object) {
|
||||
if ($object != '.' && $object != '..') {
|
||||
if (is_dir($dir . '/' . $object)) {
|
||||
Cache::rrmdir($dir . '/' . $object);
|
||||
} else {
|
||||
unlink($dir . '/' . $object);
|
||||
}
|
||||
}
|
||||
}
|
||||
rmdir($dir);
|
||||
}
|
||||
}
|
||||
}
|
||||
305
libs/Config.php
305
libs/Config.php
|
|
@ -1,305 +0,0 @@
|
|||
<?php namespace Todaymade\Daux;
|
||||
|
||||
use Todaymade\Daux\Format\Confluence\Config as ConfluenceConfig;
|
||||
use Todaymade\Daux\Format\HTML\Config as HTMLConfig;
|
||||
use Todaymade\Daux\Format\HTML\Theme as Theme;
|
||||
use Todaymade\Daux\Tree\Content;
|
||||
use Todaymade\Daux\Tree\Entry;
|
||||
|
||||
class Config extends BaseConfig
|
||||
{
|
||||
public function getTitle()
|
||||
{
|
||||
return $this->getValue('title');
|
||||
}
|
||||
|
||||
public function hasAuthor(): bool
|
||||
{
|
||||
return $this->hasValue('author');
|
||||
}
|
||||
|
||||
public function getAuthor()
|
||||
{
|
||||
return $this->getValue('author');
|
||||
}
|
||||
|
||||
public function hasTagline(): bool
|
||||
{
|
||||
return $this->hasValue('tagline');
|
||||
}
|
||||
|
||||
public function getTagline()
|
||||
{
|
||||
return $this->getValue('tagline');
|
||||
}
|
||||
|
||||
public function getCurrentPage()
|
||||
{
|
||||
return $this->getValue('current_page');
|
||||
}
|
||||
|
||||
public function setCurrentPage(Content $entry)
|
||||
{
|
||||
$this->setValue('current_page', $entry);
|
||||
}
|
||||
|
||||
public function getDocumentationDirectory()
|
||||
{
|
||||
return $this->getValue('docs_directory');
|
||||
}
|
||||
|
||||
public function getThemesDirectory()
|
||||
{
|
||||
return $this->getValue('themes_directory');
|
||||
}
|
||||
|
||||
public function getThemesPath()
|
||||
{
|
||||
return $this->getValue('themes_path');
|
||||
}
|
||||
|
||||
public function getFormat()
|
||||
{
|
||||
return $this->getValue('format');
|
||||
}
|
||||
|
||||
public function hasTimezone(): bool
|
||||
{
|
||||
return isset($this['timezone']);
|
||||
}
|
||||
|
||||
public function getTimezone()
|
||||
{
|
||||
return $this->getValue('timezone');
|
||||
}
|
||||
|
||||
public function getTree()
|
||||
{
|
||||
return $this->getValue('tree');
|
||||
}
|
||||
|
||||
public function setTree($tree)
|
||||
{
|
||||
$this->setValue('tree', $tree);
|
||||
}
|
||||
|
||||
public function isMultilanguage(): bool
|
||||
{
|
||||
return $this->hasValue('languages') && !empty($this->getValue('languages'));
|
||||
}
|
||||
|
||||
public function getLanguages(): array
|
||||
{
|
||||
return $this->getValue('languages');
|
||||
}
|
||||
|
||||
public function getLanguage(): string
|
||||
{
|
||||
return $this->getValue('language');
|
||||
}
|
||||
|
||||
public function getMode()
|
||||
{
|
||||
return $this->getValue('mode');
|
||||
}
|
||||
|
||||
public function isLive()
|
||||
{
|
||||
return $this->getValue('mode') == Daux::LIVE_MODE;
|
||||
}
|
||||
|
||||
public function isStatic()
|
||||
{
|
||||
return $this->getValue('mode') == Daux::STATIC_MODE;
|
||||
}
|
||||
|
||||
public function shouldInheritIndex()
|
||||
{
|
||||
// As the global configuration is always present, we
|
||||
// need to test for the existence of the legacy value
|
||||
// first. Then use the current value.
|
||||
if ($this->hasValue('live') && array_key_exists('inherit_index', $this['live'])) {
|
||||
return $this['live']['inherit_index'];
|
||||
}
|
||||
|
||||
return $this['html']['inherit_index'];
|
||||
}
|
||||
|
||||
public function getIndexKey()
|
||||
{
|
||||
return $this->getValue('mode') == Daux::STATIC_MODE ? 'index.html' : 'index';
|
||||
}
|
||||
|
||||
public function getProcessor()
|
||||
{
|
||||
return $this->getValue('processor');
|
||||
}
|
||||
|
||||
public function getConfluenceConfiguration(): ConfluenceConfig
|
||||
{
|
||||
return new ConfluenceConfig($this->hasValue('confluence') ? $this->getValue('confluence') : []);
|
||||
}
|
||||
|
||||
public function getHTML(): HTMLConfig
|
||||
{
|
||||
return new HTMLConfig($this->hasValue('html') ? $this->getValue('html') : []);
|
||||
}
|
||||
|
||||
public function getTheme(): ?Theme
|
||||
{
|
||||
return $this->hasValue('theme') ? new Theme($this->getValue('theme')) : null;
|
||||
}
|
||||
|
||||
public function getValidContentExtensions()
|
||||
{
|
||||
return $this->getValue('valid_content_extensions');
|
||||
}
|
||||
|
||||
public function setValidContentExtensions(array $value)
|
||||
{
|
||||
$this->setValue('valid_content_extensions', $value);
|
||||
}
|
||||
|
||||
public function canCache()
|
||||
{
|
||||
if ($this->hasValue('cache')) {
|
||||
return $this->getValue('cache');
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function getCacheKey()
|
||||
{
|
||||
$cloned = [];
|
||||
foreach ($this as $key => $value) {
|
||||
$cloned[$key] = ($value instanceof Entry) ? $value->dump() : $value;
|
||||
}
|
||||
|
||||
return sha1(json_encode($cloned));
|
||||
}
|
||||
|
||||
public function hasTranslationKey($language, $key): bool
|
||||
{
|
||||
return array_key_exists($language, $this['strings']) && array_key_exists($key, $this['strings'][$language]);
|
||||
}
|
||||
|
||||
public function getTranslationKey($language, $key)
|
||||
{
|
||||
return $this['strings'][$language][$key];
|
||||
}
|
||||
|
||||
public function hasImage(): bool
|
||||
{
|
||||
return $this->hasValue('image') && !empty($this->getValue('image'));
|
||||
}
|
||||
|
||||
public function getImage()
|
||||
{
|
||||
return $this->getValue('image');
|
||||
}
|
||||
|
||||
public function setImage($value)
|
||||
{
|
||||
$this->setValue('image', $value);
|
||||
}
|
||||
|
||||
public function getLocalBase()
|
||||
{
|
||||
return $this->getValue('local_base');
|
||||
}
|
||||
|
||||
public function getTemplates()
|
||||
{
|
||||
return $this->getValue('templates');
|
||||
}
|
||||
|
||||
public function getBaseUrl()
|
||||
{
|
||||
return $this->getValue('base_url');
|
||||
}
|
||||
|
||||
public function getBasePage()
|
||||
{
|
||||
if ($this->isLive()) {
|
||||
$value = '//' . $this->getBaseUrl();
|
||||
if (!$this['live']['clean_urls']) {
|
||||
$value .= 'index.php/';
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
return $this->getBaseUrl();
|
||||
}
|
||||
|
||||
public function hasEntryPage(): bool
|
||||
{
|
||||
return $this->hasValue('entry_page') && !empty($this->getValue('entry_page'));
|
||||
}
|
||||
|
||||
public function getEntryPage()
|
||||
{
|
||||
return $this->getValue('entry_page');
|
||||
}
|
||||
|
||||
public function setEntryPage($value)
|
||||
{
|
||||
$this->setValue('entry_page', $value);
|
||||
}
|
||||
|
||||
public function hasRequest(): bool
|
||||
{
|
||||
return $this->hasValue('request') && !empty($this->getValue('request'));
|
||||
}
|
||||
|
||||
public function getRequest()
|
||||
{
|
||||
return $this->getValue('request');
|
||||
}
|
||||
|
||||
public function setRequest($value)
|
||||
{
|
||||
$this->setValue('request', $value);
|
||||
}
|
||||
|
||||
public function getIndex()
|
||||
{
|
||||
return $this->getValue('index');
|
||||
}
|
||||
|
||||
public function setIndex($value)
|
||||
{
|
||||
$this->setValue('index', $value);
|
||||
}
|
||||
|
||||
public function hasProcessorInstance()
|
||||
{
|
||||
return $this->hasValue('processor_instance');
|
||||
}
|
||||
|
||||
public function getProcessorInstance()
|
||||
{
|
||||
return $this->getValue('processor_instance');
|
||||
}
|
||||
|
||||
public function setProcessorInstance($value)
|
||||
{
|
||||
$this->setValue('processor_instance', $value);
|
||||
}
|
||||
|
||||
public function getIgnore()
|
||||
{
|
||||
return $this->getValue('ignore');
|
||||
}
|
||||
|
||||
public function hasHost()
|
||||
{
|
||||
return $this->hasValue('host');
|
||||
}
|
||||
|
||||
public function getHost()
|
||||
{
|
||||
return $this->getValue('host');
|
||||
}
|
||||
}
|
||||
|
|
@ -1,327 +0,0 @@
|
|||
<?php namespace Todaymade\Daux;
|
||||
|
||||
class ConfigBuilder
|
||||
{
|
||||
/** @var Config */
|
||||
private $config;
|
||||
|
||||
/** @var array */
|
||||
private $overrideValues = [];
|
||||
|
||||
private $configuration_override_file;
|
||||
|
||||
private function __construct(string $mode)
|
||||
{
|
||||
$this->config = new Config();
|
||||
$this->config['mode'] = $mode;
|
||||
$this->config['local_base'] = dirname(__DIR__);
|
||||
}
|
||||
|
||||
public static function fromFile($file): Config
|
||||
{
|
||||
return unserialize(file_get_contents($file));
|
||||
}
|
||||
|
||||
public static function withMode($mode = Daux::STATIC_MODE): ConfigBuilder
|
||||
{
|
||||
$builder = new ConfigBuilder($mode);
|
||||
$builder->loadBaseConfiguration();
|
||||
|
||||
return $builder;
|
||||
}
|
||||
|
||||
public function with(array $values): ConfigBuilder
|
||||
{
|
||||
$this->config->merge($values);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
private function setValue(Config $array, $key, $value)
|
||||
{
|
||||
if (is_null($key)) {
|
||||
return $array = $value;
|
||||
}
|
||||
$keys = explode('.', $key);
|
||||
while (count($keys) > 1) {
|
||||
$key = array_shift($keys);
|
||||
if (!isset($array[$key]) || !is_array($array[$key])) {
|
||||
$array[$key] = [];
|
||||
}
|
||||
$array = &$array[$key];
|
||||
}
|
||||
$array[array_shift($keys)] = $value;
|
||||
}
|
||||
|
||||
public function withValues(array $values): ConfigBuilder
|
||||
{
|
||||
$this->overrideValues = $values;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withDocumentationDirectory($dir): ConfigBuilder
|
||||
{
|
||||
$this->config['docs_directory'] = $dir;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withValidContentExtensions(array $value): ConfigBuilder
|
||||
{
|
||||
$this->config['valid_content_extensions'] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withThemesPath($themePath): ConfigBuilder
|
||||
{
|
||||
$this->config['themes_path'] = $themePath;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withThemesDirectory($directory): ConfigBuilder
|
||||
{
|
||||
$this->config['themes_directory'] = $directory;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withCache(bool $value): ConfigBuilder
|
||||
{
|
||||
$this->config['cache'] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withFormat($format): ConfigBuilder
|
||||
{
|
||||
$this->config['format'] = $format;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withConfigurationOverride($file): ConfigBuilder
|
||||
{
|
||||
$this->configuration_override_file = $file;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withProcessor($value): ConfigBuilder
|
||||
{
|
||||
$this->config['processor'] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function withConfluenceDelete($value): ConfigBuilder
|
||||
{
|
||||
$this->config['confluence']['delete'] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function build(): Config
|
||||
{
|
||||
$this->initializeConfiguration();
|
||||
|
||||
foreach ($this->overrideValues as $value) {
|
||||
$this->setValue($this->config, $value[0], $value[1]);
|
||||
}
|
||||
|
||||
return $this->config;
|
||||
}
|
||||
|
||||
private function resolveThemeVariant()
|
||||
{
|
||||
$theme = $this->config->getHTML()->getTheme();
|
||||
$themesPath = $this->config->getThemesPath() . DIRECTORY_SEPARATOR;
|
||||
|
||||
// If theme directory exists, we're good with that
|
||||
if (is_dir(realpath(($themesPath . $theme)))) {
|
||||
return [$theme, ''];
|
||||
}
|
||||
|
||||
$themePieces = explode('-', $theme);
|
||||
$variant = '';
|
||||
|
||||
// Do we have a variant or only a theme ?
|
||||
if (count($themePieces) > 1) {
|
||||
$variant = array_pop($themePieces);
|
||||
$theme = implode('-', $themePieces);
|
||||
}
|
||||
|
||||
if (!is_dir(realpath($themesPath . $theme))) {
|
||||
throw new \RuntimeException("Theme '{$theme}' not found");
|
||||
}
|
||||
|
||||
return [$theme, $variant];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $override_file
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
private function initializeConfiguration()
|
||||
{
|
||||
// Validate and set theme path
|
||||
$docs_path = $this->normalizeDocumentationPath($this->config->getDocumentationDirectory());
|
||||
$this->config['docs_directory'] = $docs_path;
|
||||
|
||||
// Read documentation overrides
|
||||
$this->loadConfiguration($docs_path . DIRECTORY_SEPARATOR . 'config.json');
|
||||
|
||||
// Read command line overrides
|
||||
$override_file = $this->getConfigurationOverride($this->configuration_override_file);
|
||||
if ($override_file !== null) {
|
||||
$this->loadConfiguration($override_file);
|
||||
}
|
||||
|
||||
// Validate and set theme path
|
||||
$this->withThemesPath($this->normalizeThemePath($this->config->getThemesDirectory()));
|
||||
|
||||
// Resolve variant once
|
||||
$theme = $this->resolveThemeVariant();
|
||||
$this->config['html']['theme'] = $theme[0];
|
||||
$this->config['html']['theme-variant'] = $theme[1];
|
||||
|
||||
// Set a valid default timezone
|
||||
if ($this->config->hasTimezone()) {
|
||||
date_default_timezone_set($this->config->getTimezone());
|
||||
} elseif (!ini_get('date.timezone')) {
|
||||
date_default_timezone_set('GMT');
|
||||
}
|
||||
|
||||
// Text search would be too slow on live server
|
||||
if ($this->config->isLive()) {
|
||||
$this->config['html']['search'] = false;
|
||||
}
|
||||
}
|
||||
|
||||
private function normalizeThemePath($path)
|
||||
{
|
||||
$validPath = $this->findLocation($path, $this->config->getLocalBase(), 'dir');
|
||||
|
||||
if (!$validPath) {
|
||||
throw new Exception('The Themes directory does not exist. Check the path again : ' . $path);
|
||||
}
|
||||
|
||||
return $validPath;
|
||||
}
|
||||
|
||||
private function normalizeDocumentationPath($path)
|
||||
{
|
||||
$validPath = $this->findLocation($path, $this->config->getLocalBase(), 'dir');
|
||||
|
||||
if (!$validPath) {
|
||||
throw new Exception('The Docs directory does not exist. Check the path again : ' . $path);
|
||||
}
|
||||
|
||||
return $validPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load and validate the global configuration.
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
private function loadBaseConfiguration()
|
||||
{
|
||||
// Set the default configuration
|
||||
$this->config->merge([
|
||||
'docs_directory' => 'docs',
|
||||
'valid_content_extensions' => ['md', 'markdown'],
|
||||
|
||||
//Paths and tree
|
||||
'templates' => 'templates',
|
||||
|
||||
'base_url' => '',
|
||||
]);
|
||||
|
||||
// Load the global configuration
|
||||
$this->loadConfiguration($this->config->getLocalBase() . DIRECTORY_SEPARATOR . 'global.json', false);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $config_file
|
||||
* @param bool $optional
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
private function loadConfiguration($config_file, $optional = true)
|
||||
{
|
||||
if (!file_exists($config_file)) {
|
||||
if ($optional) {
|
||||
return;
|
||||
}
|
||||
|
||||
throw new Exception('The configuration file is missing. Check path : ' . $config_file);
|
||||
}
|
||||
|
||||
$config = json_decode(file_get_contents($config_file), true);
|
||||
if (!isset($config)) {
|
||||
throw new Exception('The configuration file "' . $config_file . '" is corrupt. Is your JSON well-formed ?');
|
||||
}
|
||||
$this->config->merge($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the file requested for configuration overrides.
|
||||
*
|
||||
* @param null|string $path
|
||||
*
|
||||
* @throws Exception
|
||||
*
|
||||
* @return null|string the path to a file to load for configuration overrides
|
||||
*/
|
||||
private function getConfigurationOverride($path)
|
||||
{
|
||||
$validPath = $this->findLocation($path, $this->config->getLocalBase(), 'file');
|
||||
|
||||
if ($validPath === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!$validPath) {
|
||||
throw new Exception('The configuration override file does not exist. Check the path again : ' . $path);
|
||||
}
|
||||
|
||||
return $validPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param null|string $path
|
||||
* @param string $basedir
|
||||
* @param string $type
|
||||
*
|
||||
* @return null|false|string
|
||||
*/
|
||||
private function findLocation($path, $basedir, $type)
|
||||
{
|
||||
// If Path is explicitly null, it's useless to go further
|
||||
if ($path === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// VFS, used only in tests
|
||||
if (substr($path, 0, 6) == 'vfs://') {
|
||||
return $path;
|
||||
}
|
||||
|
||||
// Check if it's relative to the current directory or an absolute path
|
||||
if (DauxHelper::is($path, $type)) {
|
||||
return DauxHelper::getAbsolutePath($path);
|
||||
}
|
||||
|
||||
// Check if it exists relative to Daux's root
|
||||
$newPath = $basedir . DIRECTORY_SEPARATOR . $path;
|
||||
if (DauxHelper::is($newPath, $type)) {
|
||||
return $newPath;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
<?php namespace Todaymade\Daux\Console;
|
||||
|
||||
use Symfony\Component\Console\Application as SymfonyApplication;
|
||||
|
||||
class Application extends SymfonyApplication
|
||||
{
|
||||
public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
|
||||
{
|
||||
parent::__construct($name, $version);
|
||||
|
||||
$this->add(new Generate());
|
||||
$this->add(new Serve());
|
||||
$this->add(new ClearCache());
|
||||
|
||||
$app_name = 'daux/daux.io';
|
||||
|
||||
$up = '..' . DIRECTORY_SEPARATOR;
|
||||
$composer = __DIR__ . DIRECTORY_SEPARATOR . $up . $up . $up . $up . $up . 'composer.lock';
|
||||
$version = 'unknown';
|
||||
|
||||
if (file_exists($composer)) {
|
||||
$app = json_decode(file_get_contents($composer));
|
||||
$packages = $app->packages;
|
||||
|
||||
foreach ($packages as $package) {
|
||||
if ($package->name == $app_name) {
|
||||
$version = $package->version;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->setVersion($version);
|
||||
$this->setName($app_name);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<?php namespace Todaymade\Daux\Console;
|
||||
|
||||
use Symfony\Component\Console\Command\Command as SymfonyCommand;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Todaymade\Daux\Cache;
|
||||
|
||||
class ClearCache extends SymfonyCommand
|
||||
{
|
||||
protected function configure()
|
||||
{
|
||||
$this
|
||||
->setName('clear-cache')
|
||||
->setDescription('Clears the cache');
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output)
|
||||
{
|
||||
$output->writeln("Clearing cache at '" . Cache::getDirectory() . "'");
|
||||
Cache::clear();
|
||||
$output->writeln('<info>Cache cleared</info>');
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,67 +0,0 @@
|
|||
<?php namespace Todaymade\Daux\Console;
|
||||
|
||||
use Symfony\Component\Console\Command\Command as SymfonyCommand;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Todaymade\Daux\ConfigBuilder;
|
||||
use Todaymade\Daux\Daux;
|
||||
|
||||
class DauxCommand extends SymfonyCommand
|
||||
{
|
||||
protected function configure()
|
||||
{
|
||||
$this
|
||||
->addOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'Configuration file')
|
||||
->addOption('source', 's', InputOption::VALUE_REQUIRED, 'Where to take the documentation from')
|
||||
->addOption('processor', 'p', InputOption::VALUE_REQUIRED, 'Manipulations on the tree')
|
||||
->addOption('no-cache', null, InputOption::VALUE_NONE, 'Disable Cache')
|
||||
->addOption('themes', 't', InputOption::VALUE_REQUIRED, 'Set a different themes directory (Used by HTML format only)')
|
||||
->addOption('value', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Set different configuration values');
|
||||
}
|
||||
|
||||
protected function prepareConfig($mode, InputInterface $input, OutputInterface $output): ConfigBuilder
|
||||
{
|
||||
$builder = ConfigBuilder::withMode($mode);
|
||||
|
||||
if ($input->getOption('configuration')) {
|
||||
$builder->withConfigurationOverride($input->getOption('configuration'));
|
||||
}
|
||||
|
||||
if ($input->getOption('source')) {
|
||||
$builder->withDocumentationDirectory($input->getOption('source'));
|
||||
}
|
||||
|
||||
if ($input->getOption('processor')) {
|
||||
$builder->withProcessor($input->getOption('processor'));
|
||||
}
|
||||
|
||||
if ($input->getOption('no-cache')) {
|
||||
$builder->withCache(false);
|
||||
}
|
||||
|
||||
if ($input->getOption('themes')) {
|
||||
$builder->withThemesDirectory($input->getOption('themes'));
|
||||
}
|
||||
|
||||
if ($input->hasOption('value')) {
|
||||
$values = array_map(
|
||||
function ($value) {
|
||||
return array_map('trim', explode('=', $value));
|
||||
},
|
||||
$input->getOption('value')
|
||||
);
|
||||
$builder->withValues($values);
|
||||
}
|
||||
|
||||
return $builder;
|
||||
}
|
||||
|
||||
protected function prepareProcessor(Daux $daux, $width)
|
||||
{
|
||||
$class = $daux->getProcessorClass();
|
||||
if (!empty($class)) {
|
||||
$daux->setProcessor(new $class($daux, $daux->getOutput(), $width));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,77 +0,0 @@
|
|||
<?php namespace Todaymade\Daux\Console;
|
||||
|
||||
use Symfony\Component\Console\Input\ArgvInput;
|
||||
use Symfony\Component\Console\Input\ArrayInput;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Terminal;
|
||||
use Todaymade\Daux\ConfigBuilder;
|
||||
use Todaymade\Daux\Daux;
|
||||
|
||||
class Generate extends DauxCommand
|
||||
{
|
||||
protected function configure()
|
||||
{
|
||||
parent::configure();
|
||||
|
||||
$description = 'Destination folder, relative to the working directory';
|
||||
|
||||
$this
|
||||
->setName('generate')
|
||||
->setDescription('Generate documentation')
|
||||
|
||||
->addOption('format', 'f', InputOption::VALUE_REQUIRED, 'Output format, html or confluence', 'html')
|
||||
|
||||
// Confluence format only
|
||||
->addOption('delete', null, InputOption::VALUE_NONE, 'Delete pages not linked to a documentation page (confluence)')
|
||||
|
||||
->addOption('destination', 'd', InputOption::VALUE_REQUIRED, $description, 'static');
|
||||
}
|
||||
|
||||
protected function prepareConfig($mode, InputInterface $input, OutputInterface $output): ConfigBuilder
|
||||
{
|
||||
$builder = parent::prepareConfig($mode, $input, $output);
|
||||
|
||||
// Set the format if requested
|
||||
if ($input->hasOption('format') && $input->getOption('format')) {
|
||||
$builder->withFormat($input->getOption('format'));
|
||||
}
|
||||
|
||||
if ($input->hasOption('delete') && $input->getOption('delete')) {
|
||||
$builder->withConfluenceDelete(true);
|
||||
}
|
||||
|
||||
return $builder;
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output)
|
||||
{
|
||||
// When used as a default command,
|
||||
// Symfony doesn't read the default parameters.
|
||||
// This will parse the parameters
|
||||
if ($input instanceof ArrayInput) {
|
||||
$argv = $_SERVER['argv'];
|
||||
$argv[0] = $this->getName();
|
||||
array_unshift($argv, 'binary_name');
|
||||
|
||||
$input = new ArgvInput($argv, $this->getDefinition());
|
||||
}
|
||||
|
||||
$builder = $this->prepareConfig(Daux::STATIC_MODE, $input, $output);
|
||||
$daux = new Daux($builder->build(), $output);
|
||||
|
||||
$width = (new Terminal())->getWidth();
|
||||
|
||||
// Instiantiate the processor if one is defined
|
||||
$this->prepareProcessor($daux, $width);
|
||||
|
||||
// Generate the tree
|
||||
$daux->generateTree();
|
||||
|
||||
// Generate the documentation
|
||||
$daux->getGenerator()->generateAll($input, $output, $width);
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue