Title
+ + + +[See the full list of supported languages in Daux.io](!Examples/Code_Highlighting) diff --git a/docs/01_Examples/01_GitHub_Flavored_Markdown.md b/docs/01_Features/GitHub_Flavored_Markdown.md similarity index 100% rename from docs/01_Examples/01_GitHub_Flavored_Markdown.md rename to docs/01_Features/GitHub_Flavored_Markdown.md diff --git a/docs/01_Features/Internal_links.md b/docs/01_Features/Internal_links.md new file mode 100644 index 0000000..9b7aff8 --- /dev/null +++ b/docs/01_Features/Internal_links.md @@ -0,0 +1,7 @@ +You can create links from a page to an other, the link is then resolved to the real page. + +Creating a link to another page is done exactly like a normal markdown link. In the url part, start with `!` and set the absolute path to the file, omitting the numbering and file extension + +A link to `01_Examples/05_Code_Highlighting.md` Would be written like this: `[Code Highlight Examples](!Examples/Code_Highlighting)` + +The page generation will fail if a link is wrong. diff --git a/docs/01_Features/Landing_page.md b/docs/01_Features/Landing_page.md new file mode 100644 index 0000000..9295712 --- /dev/null +++ b/docs/01_Features/Landing_page.md @@ -0,0 +1,11 @@ +If you want to create a beautiful landing page for your project, 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": "app.png" +} +``` + +> The image can be a local or remote image. By default, the path is relative to the root of the documentation diff --git a/docs/01_Features/Live_mode.md b/docs/01_Features/Live_mode.md new file mode 100644 index 0000000..3c7805e --- /dev/null +++ b/docs/01_Features/Live_mode.md @@ -0,0 +1,99 @@ +Keep in mind, this mode can be used for production, but it is not recommended. + +The whole directory must be scanned on each request. This might not make a big impact on small documentations but can be a bottleneck on bigger ones. + +### Running Locally + +There are several ways to run the docs locally. You can use something like MAMP or WAMP. + +The easiest is to use PHP 5.4's built-in server. + +For that i've included a short command, run `./serve` in the projects folder to start the local web server. By default the server will run at: http://localhost:8085 + + +### Running Remotely + +#### Clean URLs configuration + +Daux provides native support for Clean URLs provided the webserver has its URL Rewrite module enabled. +To enable the same, set the toggle in the `config.json` file in the `/docs` folder. + +```json +{ + "live": { + "clean_urls": true + } +} +``` + +#### Apache + +Copy the files from the repo to a web server that can run PHP 5.3 or greater. + +There is an included `.htaccess` for Apache web server. + +#### Nginx + +Daux.io works perfectly fine on Nginx too, just drop this configuration in your `nginx.conf` + +``` +server { + listen 8085; + server_name localhost; + + index index.html index.php; + charset utf-8; + + root /var/www/docs; + + location / { + if (!-e $request_filename){ + rewrite ^(.*)$ /index.php$1; + } + } + + location ~ \.php { + fastcgi_split_path_info ^(.+\.php)(/.+)$; + + fastcgi_pass unix:/var/run/php5-fpm.sock; + #fastcgi_pass 127.0.0.1:9000; + fastcgi_index index.php; + + include fastcgi_params; + fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; + fastcgi_param PATH_INFO $fastcgi_path_info; + } +} +``` + +### IIS + +If you have set up a local or remote IIS web site, you may need a `web.config` with: + +* A rewrite configuration, for handling clean urls. +* A mime type handler for less files, if using a custom theme. + +#### Clean URLs + +The `web.config` needs an entry for `Features
+
+
-
+#### For Authors
+
+* [Auto Generated Navigation / Page sorting](!Features/Navigation_and_Sorting)
+* [Internal documentation links](!Features/Internal_links)
+* [Github Flavored Markdown](!Features/GitHub_Flavored_Markdown)
+* [Auto created homepage/landing page](!Features/Landing_page)
+* [Multiple Output Formats](!Features/Multiple_Output_Formats)
+* [Multiple Languages Support](!Features/Multilanguage)
+* [No Build Step](!Features/Live_mode)
+* [Static Output Generation](!Features/Static_Site_Generation)
+
+
+
+#### For Authors
+
+* [Auto Generated Navigation / Page sorting](!Features/Navigation_and_Sorting)
+* [Internal documentation links](!Features/Internal_links)
+* [Github Flavored Markdown](!Features/GitHub_Flavored_Markdown)
+* [Auto created homepage/landing page](!Features/Landing_page)
+* [Multiple Output Formats](!Features/Multiple_Output_Formats)
+* [Multiple Languages Support](!Features/Multilanguage)
+* [No Build Step](!Features/Live_mode)
+* [Static Output Generation](!Features/Static_Site_Generation)
+
+
+
+#### For Developers
+
+* [Auto Syntax Highlighting](!Features/Auto_Syntax_Highlight)
+* [Extend Daux.io with Processors](!For_Developers/Creating_a_Processor)
+* Full access to the internal API to create new pages programatically
+* Work with pages metadata
+
+
+
+
+#### For Marketing
* 100% Mobile Responsive
-* Supports GitHub Flavored Markdown
-* Auto created homepage/landing page
-* Auto Syntax Highlighting
-* Auto Generated Navigation
* 4 Built-In Themes or roll your own
* Functional, Flat Design Style
-* Shareable/Linkable SEO Friendly URLs
-* Built On Bootstrap
-* No Build Step
-* Git/SVN Friendly
-* Supports Google Analytics and Piwik Analytics
* Optional code float layout
-* Static Output Generation
-* Internal documentation links
-* Multiple Output Formats
-* Extend Daux.io with Processors
+* Shareable/Linkable SEO Friendly URLs
+* Supports Google Analytics and Piwik Analytics
+
+
+