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

More updates to readme.

This commit is contained in:
Starbeamrainbowlabs 2016-06-27 08:00:17 +01:00
parent e4a034f8dc
commit 88c512bb05
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -136,7 +136,7 @@ Key | Value | Explanation
`search_tags_matches_weighting` | number | The weighting to give to search term matches found in a page's tags.
`css` | string of css | A string of css to include. Will be included in every page. This may also be a 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. 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.
`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.
## Module API Reference
I have documented (most of) the current API that you can use to create your own modules. You can find it in the [Module_API_Docs.md](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md) file in this repository.
@ -151,11 +151,11 @@ None yet! Contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issue
## Todo
Here's a list of things that I want to add at some point (please feel free to [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls) and help out!).
- Page history
- ~~Page history~~ (coming in 0.12!)
- Better page history
- Password changing
- Intelligent auto-updating system that doesn't wipe your settings / module choices
- Make links to non-existent pages red (#18)
- Preview changes before you save them
- Preview changes before you save them (#59)
- Commenting on pages
- ...?