From e66e4456672d6c6cd77a6a7a68673076a0541656 Mon Sep 17 00:00:00 2001 From: Cody Lundquist Date: Wed, 24 Jul 2013 20:40:50 +1000 Subject: [PATCH 1/4] Adding Munee to the list of sites that use Daux.io As requested :) - http://www.reddit.com/r/webdev/comments/1i6gbv/create_sexy_documentation_for_your_app_or_project/cb1iqm6 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3cd1f32..76b4d17 100644 --- a/README.md +++ b/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. From 034ea562b324bda605e33cf3c5b0022c036cc868 Mon Sep 17 00:00:00 2001 From: Justin Walsh Date: Wed, 24 Jul 2013 08:29:32 -0500 Subject: [PATCH 2/4] Added some custom google code to homepage --- docs/index.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 8a7c47a..4316876 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,4 +23,20 @@ * Optional code float layout
-
\ No newline at end of file +
+ + + + + \ No newline at end of file From 6bc1c0fe2b140e1441e454126da091b55b206c37 Mon Sep 17 00:00:00 2001 From: Artur Dryomov Date: Sat, 27 Jul 2013 19:07:03 +0300 Subject: [PATCH 3/4] Use syntax highlighting in the readme file. --- README.md | 112 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 66 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 76b4d17..31b6245 100644 --- a/README.md +++ b/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: - { - "title": "Daux.io", - "tagline": "The Easiest Way To Document Your Project", - "image": "img/app.png" - } +```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. @@ -74,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 - { - "title": "Daux.io" - } +```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: @@ -86,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" } @@ -95,78 +99,94 @@ 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: - { - "theme": "custom", - "colors": { - "sidebar-background": "#f7f7f7", - "sidebar-hover": "#c5c5cb", - "lines": "#e7e7e9", - "dark": "#3f4657", - "light": "#82becd", - "text": "#2d2d2d", - "syntax-string": "#022e99", - "syntax-comment": "#84989b", - "syntax-number": "#2f9b92", - "syntax-label": "#840d7a" - } +```json +{ + "theme": "custom", + "colors": { + "sidebar-background": "#f7f7f7", + "sidebar-hover": "#c5c5cb", + "lines": "#e7e7e9", + "dark": "#3f4657", + "light": "#82becd", + "text": "#2d2d2d", + "syntax-string": "#022e99", + "syntax-comment": "#84989b", + "syntax-number": "#2f9b92", + "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`. - { - "float": false - } +```json +{ + "float": false +} +``` ###GitHub Repo: Add a 'Fork me on GitHub' ribbon. - { - "repo": "justinwalsh/daux.io" - } +```json +{ + "repo": "justinwalsh/daux.io" +} +``` ###Twitter: Include twitter follow buttons in the sidebar. - { - "twitter": ["justin_walsh", "todaymade"] - } +```json +{ + "twitter": ["justin_walsh", "todaymade"] +} +``` ###Links: Include custom links in the sidebar. - { - "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" - } +```json +{ + "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. - { - "google_analytics": "UA-XXXXXXXXX-XX" - } +```json +{ + "google_analytics": "UA-XXXXXXXXX-XX" +} +``` ###Piwik Analytics: This will embed the piwik tracking code. - { - "piwik_analytics": "my-url-for-piwik.com" - } +```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"] } } +``` ## Running Remotely From d9e9ee3de6e3ec242b8bbbd6df7a81d2b5765e4d Mon Sep 17 00:00:00 2001 From: Justin Walsh Date: Sun, 28 Jul 2013 20:58:19 -0500 Subject: [PATCH 4/4] Copy README to Getting Started --- docs/00_Getting_Started.md | 113 ++++++++++++++++++++++--------------- 1 file changed, 67 insertions(+), 46 deletions(-) diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index 3cd1f32..31b6245 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.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: - { - "title": "Daux.io", - "tagline": "The Easiest Way To Document Your Project", - "image": "img/app.png" - } +```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 - { - "title": "Daux.io" - } +```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,78 +99,94 @@ 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: - { - "theme": "custom", - "colors": { - "sidebar-background": "#f7f7f7", - "sidebar-hover": "#c5c5cb", - "lines": "#e7e7e9", - "dark": "#3f4657", - "light": "#82becd", - "text": "#2d2d2d", - "syntax-string": "#022e99", - "syntax-comment": "#84989b", - "syntax-number": "#2f9b92", - "syntax-label": "#840d7a" - } +```json +{ + "theme": "custom", + "colors": { + "sidebar-background": "#f7f7f7", + "sidebar-hover": "#c5c5cb", + "lines": "#e7e7e9", + "dark": "#3f4657", + "light": "#82becd", + "text": "#2d2d2d", + "syntax-string": "#022e99", + "syntax-comment": "#84989b", + "syntax-number": "#2f9b92", + "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`. - { - "float": false - } +```json +{ + "float": false +} +``` ###GitHub Repo: Add a 'Fork me on GitHub' ribbon. - { - "repo": "justinwalsh/daux.io" - } +```json +{ + "repo": "justinwalsh/daux.io" +} +``` ###Twitter: Include twitter follow buttons in the sidebar. - { - "twitter": ["justin_walsh", "todaymade"] - } +```json +{ + "twitter": ["justin_walsh", "todaymade"] +} +``` ###Links: Include custom links in the sidebar. - { - "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" - } +```json +{ + "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. - { - "google_analytics": "UA-XXXXXXXXX-XX" - } +```json +{ + "google_analytics": "UA-XXXXXXXXX-XX" +} +``` ###Piwik Analytics: This will embed the piwik tracking code. - { - "piwik_analytics": "my-url-for-piwik.com" - } +```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"] } } +``` ## Running Remotely