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

186 lines
3.2 KiB
Markdown
Raw Normal View History

2020-04-25 14:44:43 +02:00
**Table of contents**
2015-12-12 00:22:43 +01:00
[TOC]
## Analytics
### Google Analytics
2020-04-25 14:44:43 +02:00
This will embed the google analytics tracking code.
2015-12-12 00:22:43 +01:00
```json
{
2020-04-25 14:44:43 +02:00
"html": { "google_analytics": "UA-XXXXXXXXX-XX" }
2015-12-12 00:22:43 +01:00
}
```
### Piwik Analytics
2020-04-25 14:44:43 +02:00
This will embed the piwik tracking code.
2015-12-12 00:22:43 +01:00
```json
{
2020-04-25 14:44:43 +02:00
"html": { "piwik_analytics": "my-url-for-piwik.com" }
}
```
You can Also give a specific Piwik ID as well.
```json
{
2020-04-25 14:44:43 +02:00
"html": { "piwik_analytics_id": "43" }
}
```
2020-04-24 22:22:57 +02:00
### Plausible Analytics
2020-04-25 14:44:43 +02:00
2020-04-24 22:22:57 +02:00
This will embed the https://plausible.io/ tracking code.
```json
{
2020-04-25 14:44:43 +02:00
"html": { "plausible_domain": "daux.io" }
2020-04-24 22:22:57 +02:00
}
```
## Automatic Table of Contents
2020-04-25 14:44:43 +02:00
You can add a table of contents on each page automatically, read about it [here](../01_Features/Table_of_contents.md)
## Buttons
2020-04-25 14:44:43 +02:00
You can add buttons to the landing page.
```json
{
2020-04-25 14:44:43 +02:00
"html": {
"buttons": {
"My Website": "http://example.com"
}
}
}
```
## Breadcrumb titles
2020-04-25 14:44:43 +02:00
Daux.io provides the option to present page titles as breadcrumb navigation.
You can _optionally_ specify the separator used for breadcrumbs.
```json
{
2020-04-25 14:44:43 +02:00
"html": {
"breadcrumbs": true,
"breadcrumb_separator": " > "
}
2015-12-12 00:22:43 +01:00
}
```
## Date Modified
2020-04-25 14:44:43 +02:00
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
{
2020-04-25 14:44:43 +02:00
"html": { "date_modified": false }
2015-12-12 00:22:43 +01:00
}
```
## GitHub Repo
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Add a 'Fork me on GitHub' ribbon.
```json
{
2020-04-25 14:44:43 +02:00
"html": { "repo": "dauxio/daux.io" }
2015-12-12 00:22:43 +01:00
}
```
## Inherit Index
2020-04-25 14:44:43 +02:00
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
{
2020-04-25 14:44:43 +02:00
"html": { "inherit_index": true }
}
```
## Jump buttons
2020-04-25 14:44:43 +02:00
You can have previous/next buttons on each page.
They can be disabled by setting `jump_buttons` to `false`.
```json
{
2020-04-25 14:44:43 +02:00
"html": { "jump_buttons": false }
2015-12-12 00:22:43 +01:00
}
```
## Landing page
2020-04-25 14:44:43 +02:00
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
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Include custom links in the sidebar.
```json
{
2020-04-25 14:44:43 +02:00
"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"
}
}
2015-12-12 00:22:43 +01:00
}
```
## Search
2020-04-25 14:44:43 +02:00
Daux has an embedded search engine read all about it [here](../01_Features/Search.md)
2015-12-12 00:22:43 +01:00
## Themes
2020-04-25 14:44:43 +02:00
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
2020-04-25 14:44:43 +02:00
- daux-blue
- daux-green
- daux-navy
- daux-red
2015-12-12 00:22:43 +01:00
```json
{
2020-04-25 14:44:43 +02:00
"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
{
2020-04-25 14:44:43 +02:00
"html": { "theme": "new-theme" }
2015-12-12 00:22:43 +01:00
}
```
## Toggling Code Blocks
2020-04-25 14:44:43 +02:00
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
{
2020-04-25 14:44:43 +02:00
"html": { "toggle_code": true }
}
```
## Twitter
2020-04-25 14:44:43 +02:00
Include twitter follow buttons in the sidebar.
```json
{
2020-04-25 14:44:43 +02:00
"html": { "twitter": ["justin_walsh", "todaymade"] }
2015-12-12 00:22:43 +01:00
}
```