sbrl-github/Pepperminty-Wiki
sbrl-github
/
Pepperminty-Wiki
mirror of https://github.com/sbrl/Pepperminty-Wiki.git
1
0
Fork 0
Code

Update settings list a bit in the README. 

Looks like guiconfig is the best place ot go for a description of the
settings - mayenbe I should build a special description page for those
who like to edit the settings themselves.
This commit is contained in:
Starbeamrainbowlabs 2018-03-18 21:53:28 +00:00
parent 7b580f5483
commit 3b066bf11f
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -172,6 +172,9 @@ Key | Value | Explanation
`css` | string of css | A string of css to include. Will be included in every page. This may also be an absolute url that references an external stylesheet.
`favicon` | url | A url that points to the favicon for your wiki.
`session_prefix` | string | The prefix that should be used in the names of the session variables. Defaults to an all lower case version of the site name with all non alphanumeric characters removed (The special value `auto` does this). Remember that changing this will log everyone out since the session variable's name will have changed. Normally you won't have to change this - This setting is left over from when we used a cookie to store login details. By default this is set to a safe variant of your site name.
`stats_update_interval` | number | The number of seconds which should elapse before a statistics update should be scheduled. Defaults to once a day.
`stats_update_processingtime` | number | The maximum number of milliseconds that should be spent at once calculating statistics. If some statistics couldn't fit within this limit, then they are scheduled and updated on the next page load. Note that this is a target only - if an individual statistic takes longer than this, then it won't be interrupted. Defaults to 100ms.
## API Reference
I have documented the current API and other things that make Pepperminty Wiki tick that you can use to create your own modules. You can find this documentation in the [Module_API_Docs.md](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md) file in this repository.