Merge branch 'master' of https://github.com/justinwalsh/daux.io
This commit is contained in:
Denis Kisselev
commit
d5a258c299
27
README.md
27
README.md
@ -21,6 +21,7 @@
|
||||
This is a list of sites using Daux.io:
|
||||
|
||||
* [Daux.io](http://daux.io)
|
||||
* [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
|
||||
|
||||
Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/daux.io/issues) and I will add you to the list.
|
||||
|
||||
@ -58,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:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"image": "img/app.png"
|
||||
}
|
||||
```
|
||||
|
||||
Note: The image can be a local or remote image.
|
||||
|
||||
@ -73,9 +76,11 @@ To customize the look and feel of your documentation, you can create a `config.j
|
||||
###Title:
|
||||
Change the title bar in the docs
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
###Themes:
|
||||
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
|
||||
@ -85,7 +90,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
||||
* navy
|
||||
* red
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"theme": "blue"
|
||||
}
|
||||
@ -94,6 +99,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
||||
###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:
|
||||
|
||||
```json
|
||||
{
|
||||
"theme": "custom",
|
||||
"colors": {
|
||||
@ -109,32 +115,40 @@ To create a custom color scheme, set the `theme` property to `custom` and then d
|
||||
"syntax-label": "#840d7a"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###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`.
|
||||
|
||||
```json
|
||||
{
|
||||
"float": false
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
###GitHub Repo:
|
||||
Add a 'Fork me on GitHub' ribbon.
|
||||
|
||||
```json
|
||||
{
|
||||
"repo": "justinwalsh/daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
###Twitter:
|
||||
Include twitter follow buttons in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"twitter": ["justin_walsh", "todaymade"]
|
||||
}
|
||||
```
|
||||
|
||||
###Links:
|
||||
Include custom links in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"links": {
|
||||
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
|
||||
@ -142,30 +156,37 @@ Include custom links in the sidebar.
|
||||
"Made by Todaymade": "http://todaymade.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###Google Analytics:
|
||||
This will embed the google analytics tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"google_analytics": "UA-XXXXXXXXX-XX"
|
||||
}
|
||||
```
|
||||
|
||||
###Piwik Analytics:
|
||||
This will embed the piwik tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"piwik_analytics": "my-url-for-piwik.com"
|
||||
}
|
||||
```
|
||||
|
||||
###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"]
|
||||
"files": ["Work_In_Progress.md"],
|
||||
"folders": ["99_Not_Ready"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###Disabling clean URLs
|
||||
By default, Daux.io will create clean url's that do not include index.php. On servers running Apache, uploading the included .htaccess file should be enough for them to work properly. On servers that are not running Apache or that do not allow custom .htaccess files, you may need to disable clean_urls:
|
||||
|
||||
@ -21,6 +21,7 @@
|
||||
This is a list of sites using Daux.io:
|
||||
|
||||
* [Daux.io](http://daux.io)
|
||||
* [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
|
||||
|
||||
Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/daux.io/issues) and I will add you to the list.
|
||||
|
||||
@ -58,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:
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io",
|
||||
"tagline": "The Easiest Way To Document Your Project",
|
||||
"image": "img/app.png"
|
||||
}
|
||||
```
|
||||
|
||||
Note: The image can be a local or remote image.
|
||||
|
||||
@ -73,9 +76,11 @@ To customize the look and feel of your documentation, you can create a `config.j
|
||||
###Title:
|
||||
Change the title bar in the docs
|
||||
|
||||
```json
|
||||
{
|
||||
"title": "Daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
###Themes:
|
||||
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
|
||||
@ -85,7 +90,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
||||
* navy
|
||||
* red
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"theme": "blue"
|
||||
}
|
||||
@ -94,6 +99,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
|
||||
###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:
|
||||
|
||||
```json
|
||||
{
|
||||
"theme": "custom",
|
||||
"colors": {
|
||||
@ -109,32 +115,40 @@ To create a custom color scheme, set the `theme` property to `custom` and then d
|
||||
"syntax-label": "#840d7a"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###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`.
|
||||
|
||||
```json
|
||||
{
|
||||
"float": false
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
###GitHub Repo:
|
||||
Add a 'Fork me on GitHub' ribbon.
|
||||
|
||||
```json
|
||||
{
|
||||
"repo": "justinwalsh/daux.io"
|
||||
}
|
||||
```
|
||||
|
||||
###Twitter:
|
||||
Include twitter follow buttons in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"twitter": ["justin_walsh", "todaymade"]
|
||||
}
|
||||
```
|
||||
|
||||
###Links:
|
||||
Include custom links in the sidebar.
|
||||
|
||||
```json
|
||||
{
|
||||
"links": {
|
||||
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
|
||||
@ -142,30 +156,37 @@ Include custom links in the sidebar.
|
||||
"Made by Todaymade": "http://todaymade.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###Google Analytics:
|
||||
This will embed the google analytics tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"google_analytics": "UA-XXXXXXXXX-XX"
|
||||
}
|
||||
```
|
||||
|
||||
###Piwik Analytics:
|
||||
This will embed the piwik tracking code.
|
||||
|
||||
```json
|
||||
{
|
||||
"piwik_analytics": "my-url-for-piwik.com"
|
||||
}
|
||||
```
|
||||
|
||||
###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"]
|
||||
"files": ["Work_In_Progress.md"],
|
||||
"folders": ["99_Not_Ready"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###Disabling clean URLs
|
||||
By default, Daux.io will create clean url's that do not include index.php. On servers running Apache, uploading the included .htaccess file should be enough for them to work properly. On servers that are not running Apache or that do not allow custom .htaccess files, you may need to disable clean_urls:
|
||||
|
||||
@ -24,3 +24,19 @@
|
||||
|
||||
<div class="clear"></div>
|
||||
<hr/>
|
||||
|
||||
<!-- Google Code -->
|
||||
<script type="text/javascript">
|
||||
/* <![CDATA[ */
|
||||
var google_conversion_id = 983836026;
|
||||
var google_custom_params = window.google_tag_params;
|
||||
var google_remarketing_only = true;
|
||||
/* ]]> */
|
||||
</script>
|
||||
<script type="text/javascript" src="//www.googleadservices.com/pagead/conversion.js">
|
||||
</script>
|
||||
<noscript>
|
||||
<div style="display:inline;">
|
||||
<img height="1" width="1" style="border-style:none;" alt="" src="//googleads.g.doubleclick.net/pagead/viewthroughconversion/983836026/?value=0&guid=ON&script=0"/>
|
||||
</div>
|
||||
</noscript>
|
||||
Loading…
Reference in New Issue
Block a user