daux.io/docs/05_Configuration/Html_export.md

172 lignes
3.2 KiB
Markdown
Brut Vue normale Historique

__Table of contents__
2015-12-12 00:22:43 +01:00
[TOC]
## Analytics
### Google Analytics
This will embed the google analytics tracking code.
2015-12-12 00:22:43 +01:00
```json
{
"html": { "google_analytics": "UA-XXXXXXXXX-XX" }
2015-12-12 00:22:43 +01:00
}
```
### Piwik Analytics
This will embed the piwik tracking code.
2015-12-12 00:22:43 +01:00
```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" }
}
```
## 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" : " > "
}
2015-12-12 00:22:43 +01:00
}
```
## Code Floating
By default your code blocks will be floated to a column on the right side of your content.
To disable this feature, set the `float` property to `false`.
2015-12-12 00:22:43 +01:00
```json
{
"html": { "float": false }
2015-12-12 00:22:43 +01:00
}
```
## 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.
2015-12-12 00:22:43 +01:00
```json
{
"html": { "date_modified": false }
2015-12-12 00:22:43 +01:00
}
```
## GitHub Repo
Add a 'Fork me on GitHub' ribbon.
```json
{
2017-09-13 21:43:40 +02:00
"html": { "repo": "dauxio/daux.io" }
2015-12-12 00:22:43 +01:00
}
```
## 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.
2015-12-12 00:22:43 +01:00
```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 }
2015-12-12 00:22:43 +01:00
}
```
## Landing page
The automatic landing page can be disabled through the `auto_landing` option, read about it [here](../01_Features/Landing_page.md)
2015-12-12 00:22:43 +01:00
## Links
Include custom links in the sidebar.
```json
{
"html": {
"links": {
2017-09-13 21:43:40 +02:00
"GitHub Repo": "https://github.com/dauxio/daux.io",
"Help/Support/Bugs": "https://github.com/dauxio/daux.io/issues",
"Made by Todaymade": "http://todaymade.com"
}
}
2015-12-12 00:22:43 +01:00
}
```
## Search
Daux has an embedded search engine read all about it [here](../01_Features/Search.md)
2015-12-12 00:22:43 +01:00
## Themes
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
2015-12-12 00:22:43 +01:00
* daux-blue
* daux-green
* daux-navy
* daux-red
2015-12-12 00:22:43 +01:00
```json
{
"html": { "theme": "daux-blue" }
2015-12-12 00:22:43 +01:00
}
```
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`
2015-12-12 00:22:43 +01:00
```json
{
"html": { "theme": "new-theme" }
2015-12-12 00:22:43 +01:00
}
```
## 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.
2015-12-12 00:22:43 +01:00
```json
{
"html": { "toggle_code": true }
}
```
## Twitter
Include twitter follow buttons in the sidebar.
```json
{
"html": { "twitter": ["justin_walsh", "todaymade"] }
2015-12-12 00:22:43 +01:00
}
```