Merge pull request #149 from davestephens/master

More docs!

README.md

@@ -1,6 +1,6 @@
 # ENiGMA½ BBS Software
 
-![ENiGMA½ BBS](docs/images/enigma-bbs.png "ENiGMA½ BBS")
+![ENiGMA½ BBS](docs/assets/images/enigma-bbs.png "ENiGMA½ BBS")
 
 ENiGMA½ is a modern BBS software with a nostalgic flair!
 

docs/_includes/nav.md

@@ -16,13 +16,15 @@
     - [Editing hjson]({{ site.baseurl }}{% link configuration/editing-hjson.md %})
     - [config.hjson]({{ site.baseurl }}{% link configuration/config-hjson.md %})
     - [menu.hjson]({{ site.baseurl }}{% link configuration/menu-hjson.md %})
-    - prompt.hjson
+    - [prompt.hjson]({{ site.baseurl }}{% link configuration/prompt-hjson.md %})
     - [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %})
     - [Archivers]({{ site.baseurl }}{% link configuration/archivers.md %})
     - [File Transfer Protocols]({{ site.baseurl }}{% link configuration/file-transfer-protocols.md %})
     - [Email]({{ site.baseurl }}{% link configuration/email.md %})
+    - [Colour Codes]({{ site.baseurl }}{% link configuration/colour-codes.md %})
     - Scheduled jobs
 
+
   - File Base
     - [About]({{ site.baseurl }}{% link filebase/index.md %})
     - [Configuring a File Area]({{ site.baseurl }}{% link filebase/first-file-area.md %})

docs/configuration/colour-codes.md

@@ -0,0 +1,25 @@
+---
+layout: page
+title: Colour Codes
+---
+ENiGMA½ supports Renegade-style pipe colour codes for formatting strings. You'll see them used in [`config.hjson`](config-hjson),
+[`prompt.hjson`](prompt-hjson), [`menu.hjson`](menu-hjson), and can also be used in places like the oneliner, rumour mod,
+full screen editor etc.
+
+## Usage
+When ENiGMA½ encounters colour codes in strings, they'll be processed in order and combined where possible.
+
+For example:
+
+`|15|17Example` - white text on a blue background
+
+`|10|23Example` - light green text on a light grey background
+
+
+## Colour Code Reference
+
+:warning: Colour codes |24 to |31 are considered "blinking" or "iCE" colour codes. On terminals that support them they'll 
+be shown as the correct colours - for terminals that don't, or are that are set to "blinking" mode - they'll blink!
+
+![Regegade style colour codes](../assets/images/colour-codes.png "Colour Codes")
+

docs/configuration/editing-hjson.md

@@ -14,3 +14,7 @@ You can find more info at the [Hjson.org website](http://hjson.org/).
 within the IDE. It provides syntax highlighting to make it clear when you've made a syntax mistake within
 a config file. 
 
+### Notepad++
+
+[Notepad++](https://notepad-plus-plus.org) has an Hjson plugin that provides syntax highlighting and other
+usual text editor features. The plugin can be found [here](https://github.com/laktak/npp-hjson).

docs/configuration/prompt-hjson.md

@@ -0,0 +1,6 @@
+---
+layout: page
+title: prompt.hjson
+---
+:zap: This page is to describe general information the `prompt.hjson` file. It
+needs fleshing out, please submit a PR if you'd like to help!

docs/index.md

@@ -2,7 +2,7 @@
 layout: default
 title: Home
 ---
-![ENiGMA½ BBS](images/enigma-bbs.png "ENiGMA½ BBS")
+![ENiGMA½ BBS](assets/images/enigma-bbs.png "ENiGMA½ BBS")
 
 ENiGMA½ is a modern BBS software with a nostalgic flair!
 

docs/servers/websocket.md

@@ -86,6 +86,6 @@ webserver, and unpack it to a temporary directory.
 otherwise.
     
 9. If you navigate to http://your-hostname.here/vtx.html, you should see a splash screen like the following:
-    ![VTXClient](../images/vtxclient.png "VTXClient")
+    ![VTXClient](../assets/images/vtxclient.png "VTXClient")