diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 807d988..e69835c 100755 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -5,20 +5,15 @@ Currently all values in example-config.json are required, however I plan to add All options show an example configuartion value and the variable type + an explaination below it.
## Technical configuration -* "site_url": "https://example.com"
- This value defines the url of your site, this used for the RSS feed to link back to post. -* "port": 8080
- Integer. This value defines the port that you run the blog on. Don't change this value if you don't know what that means. -* "allow_signup": true
- Boolean. Defines weather new people should be allowed to signup. -* "timeline_length": 20
- Integer. How many posts will be shown on the timeline (home page). -* "enable_hitcount": true
- Boolean. Enabling the hitcount (a number that represents the amount of front page loads (stored in hitcount.txt)) can slightly slow down loading of the front page. -* "charset": "UTF-8"
- String. This is the value in the tag in the html of all pages, you should not change this unless you know why. -* "root_path": "/path/to/root/of/website" - String. Anything in this directory will be in the webroot, so put favicon.ico and anything else here. +| name | example value | variable type | explanation | +|-----------------|----------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| site_url | "https://example.com" | String | This value defines the url of your site, this used for the RSS feed to link back to post. | +| port | 8080 | Integer | This value defines the port that you run the blog on. Don't change this value if you don't know what that means. | +| allow_signup | true | Boolean | Defines weather new people should be allowed to signup. | +| timeline_length | 20 | Integer | How many posts will be shown on the timeline (home page). | +| enable_hitcount | true | Boolean | Enabling the hitcount (a number that represents the amount of front page loads (stored in hitcount.txt)) can slightly slow down loading of the front page. | +| charset | "UTF-8" | String | This is the value in the tag in the html of all pages, you should not change this unless you know why. | +| root_path | "/path/to/root/of/website" | String | Anything in this directory will be in the webroot, so put favicon.ico and anything else here. | ## Basic Customisation * "locale": en