Use syntax highlighting in the readme file.
This commit is contained in:
parent
064770a750
commit
6bc1c0fe2b
26
README.md
26
README.md
@ -59,11 +59,13 @@ To sort your files and folders in a specific way, you can prefix them with a num
|
|||||||
|
|
||||||
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:
|
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",
|
"title": "Daux.io",
|
||||||
"tagline": "The Easiest Way To Document Your Project",
|
"tagline": "The Easiest Way To Document Your Project",
|
||||||
"image": "img/app.png"
|
"image": "img/app.png"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Note: The image can be a local or remote image.
|
Note: The image can be a local or remote image.
|
||||||
|
|
||||||
@ -74,9 +76,11 @@ To customize the look and feel of your documentation, you can create a `config.j
|
|||||||
###Title:
|
###Title:
|
||||||
Change the title bar in the docs
|
Change the title bar in the docs
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"title": "Daux.io"
|
"title": "Daux.io"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###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:
|
||||||
@ -86,7 +90,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
|||||||
* navy
|
* navy
|
||||||
* red
|
* red
|
||||||
|
|
||||||
```
|
```json
|
||||||
{
|
{
|
||||||
"theme": "blue"
|
"theme": "blue"
|
||||||
}
|
}
|
||||||
@ -95,6 +99,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
|||||||
###Custom Theme:
|
###Custom Theme:
|
||||||
To create a custom color scheme, set the `theme` property to `custom` and then define the required colors. Copy the following configuration to get started:
|
To create a custom color scheme, set the `theme` property to `custom` and then define the required colors. Copy the following configuration to get started:
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"theme": "custom",
|
"theme": "custom",
|
||||||
"colors": {
|
"colors": {
|
||||||
@ -110,32 +115,40 @@ To create a custom color scheme, set the `theme` property to `custom` and then d
|
|||||||
"syntax-label": "#840d7a"
|
"syntax-label": "#840d7a"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###Code Floating:
|
###Code Floating:
|
||||||
By deafult 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 deafult 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
|
||||||
{
|
{
|
||||||
"float": false
|
"float": false
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
###GitHub Repo:
|
###GitHub Repo:
|
||||||
Add a 'Fork me on GitHub' ribbon.
|
Add a 'Fork me on GitHub' ribbon.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"repo": "justinwalsh/daux.io"
|
"repo": "justinwalsh/daux.io"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###Twitter:
|
###Twitter:
|
||||||
Include twitter follow buttons in the sidebar.
|
Include twitter follow buttons in the sidebar.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"twitter": ["justin_walsh", "todaymade"]
|
"twitter": ["justin_walsh", "todaymade"]
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###Links:
|
###Links:
|
||||||
Include custom links in the sidebar.
|
Include custom links in the sidebar.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"links": {
|
"links": {
|
||||||
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
|
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
|
||||||
@ -143,30 +156,37 @@ Include custom links in the sidebar.
|
|||||||
"Made by Todaymade": "http://todaymade.com"
|
"Made by Todaymade": "http://todaymade.com"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###Google Analytics:
|
###Google Analytics:
|
||||||
This will embed the google analytics tracking code.
|
This will embed the google analytics tracking code.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"google_analytics": "UA-XXXXXXXXX-XX"
|
"google_analytics": "UA-XXXXXXXXX-XX"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###Piwik Analytics:
|
###Piwik Analytics:
|
||||||
This will embed the piwik tracking code.
|
This will embed the piwik tracking code.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"piwik_analytics": "my-url-for-piwik.com"
|
"piwik_analytics": "my-url-for-piwik.com"
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
###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
|
||||||
{
|
{
|
||||||
"ignore": {
|
"ignore": {
|
||||||
files: ["Work_In_Progress.md"],
|
"files": ["Work_In_Progress.md"],
|
||||||
folders: ["99_Not_Ready"]
|
"folders": ["99_Not_Ready"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Running Remotely
|
## Running Remotely
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user