diff --git a/README.md b/README.md index 6167d8f..e7830cd 100644 --- a/README.md +++ b/README.md @@ -191,16 +191,29 @@ Set custom files and entire folders to ignore within your `/docs` folder. For fi ###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: - { +```json +{ "clean_urls": false - } +} +``` + +###Date Modified +By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false. + +```json +{ + "date_modified": false +} +``` ###Timezone If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). - { +```json +{ "timezone": "America/Los_Angeles" - } +} +``` ## Running Remotely @@ -221,6 +234,52 @@ The Grunt.js task uses the built in web server in PHP 5.4 to host the docs on yo This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` in the projects folder to start the local web server. By default the server will run at: http://localhost:8085 +## Running on 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 `` under ``: + +```xml + + + + + + + + + + + + + + + + +``` + +To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as [URL Rewriter](http://urlrewriter.net/). + +### Less Mime Type + +The `web.config` needs a new `` entry, under `` in ``: + +```xml + + + +``` + +You will only need the mime map entry if you are using a custom theme and receive 404s for `.less` files. + +If you have a global mime map entry for `.less` files set for the server, you will receive an internal server (500) error for having duplicate mime map entries. + ## Support If you need help using Daux.io, or have found a bug, please create an issue on the GitHub repo. diff --git a/css/daux-blue.css b/css/daux-blue.css index a74fdd8..3b4f6fb 100644 --- a/css/daux-blue.css +++ b/css/daux-blue.css @@ -6720,11 +6720,15 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #82becd; diff --git a/css/daux-green.css b/css/daux-green.css index 1f846e4..2f61116 100644 --- a/css/daux-green.css +++ b/css/daux-green.css @@ -6720,11 +6720,15 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #8acc37; diff --git a/css/daux-navy.css b/css/daux-navy.css index 77287f9..c95a02a 100644 --- a/css/daux-navy.css +++ b/css/daux-navy.css @@ -6720,11 +6720,15 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #7795b4; diff --git a/css/daux-red.css b/css/daux-red.css index 7017f8a..6049831 100644 --- a/css/daux-red.css +++ b/css/daux-red.css @@ -6720,11 +6720,15 @@ code { } .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; } .page-header h1 { margin-top: 0px; } +/* To be applied to the same element as page-header for sites that have sub-heading content such as Last modified time */ +.page-header .sub-heading { + padding: 0px, 0px, 20px; +} pre { border: none; background-color: #ecb5a1; diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index 42208c2..e7830cd 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -191,9 +191,29 @@ Set custom files and entire folders to ignore within your `/docs` folder. For fi ###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: - { +```json +{ "clean_urls": false - } +} +``` + +###Date Modified +By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false. + +```json +{ + "date_modified": false +} +``` + +###Timezone +If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the [PHP Manual](http://php.net/manual/en/timezones.php). + +```json +{ + "timezone": "America/Los_Angeles" +} +``` ## Running Remotely @@ -214,6 +234,52 @@ The Grunt.js task uses the built in web server in PHP 5.4 to host the docs on yo This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` in the projects folder to start the local web server. By default the server will run at: http://localhost:8085 +## Running on 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 `` under ``: + +```xml + + + + + + + + + + + + + + + + +``` + +To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as [URL Rewriter](http://urlrewriter.net/). + +### Less Mime Type + +The `web.config` needs a new `` entry, under `` in ``: + +```xml + + + +``` + +You will only need the mime map entry if you are using a custom theme and receive 404s for `.less` files. + +If you have a global mime map entry for `.less` files set for the server, you will receive an internal server (500) error for having duplicate mime map entries. + ## Support If you need help using Daux.io, or have found a bug, please create an issue on the GitHub repo. diff --git a/docs/config.json b/docs/config.json index c133ecf..3dbd75c 100644 --- a/docs/config.json +++ b/docs/config.json @@ -3,6 +3,7 @@ "tagline": "The Easiest Way To Document Your Project", "image": "img/app.png", "theme": "navy", + "date_modified": true, "repo": "justinwalsh/daux.io", "twitter": ["justin_walsh", "todaymade"], "google_analytics": "UA-12653604-10", diff --git a/index.php b/index.php index 41d0c75..ee5dba2 100644 --- a/index.php +++ b/index.php @@ -70,6 +70,8 @@ $tree = get_tree("docs", $base_url); $homepage_url = homepage_url($tree); $docs_url = docs_url($tree); +$page = load_page($tree); + // If a timezone has been set in the config file, override the default PHP timezone for this application. if(isset($options['timezone'])) { @@ -182,8 +184,8 @@ if ($homepage && $homepage_url !== '/') {
-
- +
+
@@ -265,7 +267,23 @@ if ($homepage && $homepage_url !== '/') {
- + +
+

+ + + + + + +
+ +
+

+
+ + +
diff --git a/less/import/daux-base.less b/less/import/daux-base.less index ca4a8ff..58e9555 100644 --- a/less/import/daux-base.less +++ b/less/import/daux-base.less @@ -474,10 +474,13 @@ code { .page-header { margin: 10px 0px; - padding: 0px 0 20px; + padding: 0px; h1 { margin-top: 0px; } + sub-heading { + padding: 0px, 0px, 20px; + } } pre { border: none; diff --git a/libs/functions.php b/libs/functions.php index c26e804..fca70bd 100644 --- a/libs/functions.php +++ b/libs/functions.php @@ -1,6 +1,7 @@ false, 'image' => false, 'theme' => 'blue', + 'date_modified' => true, 'float' => true, 'repo' => false, 'twitter' => array(), @@ -102,28 +104,29 @@ function docs_url($tree, $branch = false) { function load_page($tree) { $branch = find_branch($tree); + $page = array(); + if (isset($branch['type']) && $branch['type'] == 'file') { $html = ''; if ($branch['name'] !== 'index') { - $html .= '
'; - $html .= '

'. $branch['title'] . '

'; - // Show last modified time for docs. Needs to be cleaned up and use template colours. - $modified = filemtime($branch['path']); - $html .= ''; - $html .= date ("l, F j, Y", $modified); - $html .= ''; - $html .= date ("g:i A", $modified); - $html .= ''; - - $html .= '
'; + $page['title'] = $branch['title']; + $page['modified'] = filemtime($branch['path']); } $html .= MarkdownExtended(file_get_contents($branch['path'])); - return $html; + + $page['html'] = $html; + } else { - return "Oh No. That page dosn't exist"; + + $page['title'] = "Oh no"; + $page['html'] = "

Oh No. That page dosn't exist

"; + } + + + return $page; } function find_branch($tree) {