Improve documentation add missing examples, adds to #453

justinwalsh · May 16, 2017 · 30b6b2c · 30b6b2c
1 parent 207052a
commit 30b6b2c
Show file tree

Hide file tree

Showing 4 changed files with 127 additions and 227 deletions.
diff --git a/README.md b/README.md
@@ -141,174 +141,11 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
 }
 ```
 
-### Custom Theme
-To use a custom theme, just copy over the theme folder as well as the `.thm` file for that theme into the `themes` directory and set its value in the `theme` param in config.json
-
-```json
-{
-  "html": { "theme": "new-theme" }
-}
-```
-
-### 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`.
-
-```json
-{
-  "html": { "float": false }
-}
-```
-
-### 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 }
-}
-```
-
-
-### GitHub Repo
-Add a 'Fork me on GitHub' ribbon.
-
-```json
-{
-  "html": { "repo": "justinwalsh/daux.io" }
-}
-```
-
-### Twitter
-Include twitter follow buttons in the sidebar.
-
-```json
-{
-  "html": { "twitter": ["justin_walsh", "todaymade"] }
-}
-```
-
-### Links
-Include custom links in the sidebar.
-
-```json
-{
-  "html": {
-    "links": {
-      "GitHub Repo": "https://github.com/justinwalsh/daux.io",
-      "Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
-      "Made by Todaymade": "http://todaymade.com"
-    }
-  }
-}
-```
-
-### 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" }
-}
-```
-
-### 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 }
-}
-```
-
-### 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 }
-}
-```
-
-### 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 seperate 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_GitHub_Flavored_Markdown.md
-│   │   │   ├── 05_Code_Highlighting.md
-│   │   ├── 05_More_Examples
-│   │   │   ├── Hello_World.md
-│   │   │   ├── 05_Code_Highlighting.md
-│   ├── de
-│   │   ├── 00_Getting_Started.md
-│   │   ├── 01_Examples
-│   │   │   ├── 01_GitHub_Flavored_Markdown.md
-│   │   │   ├── 05_Code_Highlighting.md
-│   │   ├── 05_More_Examples
-│   │   │   ├── Hello_World.md
-│   │   │   ├── 05_Code_Highlighting.md
-```
+### 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
 

diff --git a/docs/05_Configuration/Confluence_upload.md b/docs/05_Configuration/Confluence_upload.md
@@ -1,3 +1,7 @@
+__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.
 
@@ -36,7 +40,7 @@ Because confluence can't have two pages with the same name in a space, I recomme
 
 ```json
 {
-  "confluence": { "prefix": "[DAUX]" }
+  "confluence": { "prefix": "DAUX -" }
 }
 ```