Merge pull request #446 from bennyn/patch-1
Fixed Markdown styling for third-tier heading
This commit is contained in:
commit
dd1a52af65
20
README.md
20
README.md
@ -117,7 +117,7 @@ If you are interested in having a landing page for a subsection of your docs, al
|
|||||||
To customize the look and feel of your documentation, you can create a `config.json` file in the of the `/docs` folder.
|
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.
|
The `config.json` file is a simple JSON object that you can use to change some of the basic settings of the documentation.
|
||||||
|
|
||||||
###Title:
|
### Title
|
||||||
Change the title bar in the docs
|
Change the title bar in the docs
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -126,7 +126,7 @@ Change the title bar in the docs
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Themes:
|
### Themes
|
||||||
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
|
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-blue
|
||||||
@ -142,7 +142,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Custom Theme:
|
### 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
|
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
|
```json
|
||||||
@ -151,7 +151,7 @@ To use a custom theme, just copy over the theme folder as well as the `.thm` fil
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Code Floating:
|
### 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`.
|
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
|
```json
|
||||||
@ -170,7 +170,7 @@ Some users might wish to hide the code blocks & view just the documentation. By
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
###GitHub Repo:
|
### GitHub Repo
|
||||||
Add a 'Fork me on GitHub' ribbon.
|
Add a 'Fork me on GitHub' ribbon.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -179,7 +179,7 @@ Add a 'Fork me on GitHub' ribbon.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Twitter:
|
### Twitter
|
||||||
Include twitter follow buttons in the sidebar.
|
Include twitter follow buttons in the sidebar.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -188,7 +188,7 @@ Include twitter follow buttons in the sidebar.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Links:
|
### Links
|
||||||
Include custom links in the sidebar.
|
Include custom links in the sidebar.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -201,7 +201,7 @@ Include custom links in the sidebar.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Google Analytics:
|
### Google Analytics
|
||||||
This will embed the google analytics tracking code.
|
This will embed the google analytics tracking code.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -210,7 +210,7 @@ This will embed the google analytics tracking code.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Piwik Analytics:
|
### Piwik Analytics
|
||||||
This will embed the piwik tracking code.
|
This will embed the piwik tracking code.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -227,7 +227,7 @@ You can Also give a specific Piwik ID as well.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
###Ignore:
|
### 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.
|
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
|
```json
|
||||||
|
Loading…
x
Reference in New Issue
Block a user