Update readme & prepare for next beta version
This commit is contained in:
parent
88c512bb05
commit
ff4d065b1f
13
README.md
13
README.md
|
|
@ -1,11 +1,10 @@
|
||||||
# Pepperminty Wiki
|
# Pepperminty Wiki [](https://travis-ci.org/sbrl/Pepperminty-Wiki) [](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE)
|
||||||
A Wiki in a box
|
A Wiki in a box
|
||||||
|
|
||||||
[](https://travis-ci.org/sbrl/Pepperminty-Wiki)
|
|
||||||
[](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE)
|
|
||||||
|
|
||||||
Pepperminty Wiki is a complete wiki contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/Minty-Wiki). It's open source too (under MPL-2.0), so contributions are welcome!
|
Pepperminty Wiki is a complete wiki contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/Minty-Wiki). It's open source too (under MPL-2.0), so contributions are welcome!
|
||||||
|
|
||||||
|
**Latest Version:** v0.12 (stable) v0.13-dev (development)
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -20,7 +19,9 @@ Above: A Main Page.
|
||||||
- Templating support
|
- Templating support
|
||||||
- Additional syntax for resizing and floating images
|
- Additional syntax for resizing and floating images
|
||||||
- File galleries
|
- File galleries
|
||||||
|
- Short syntax for referencing uploaded files
|
||||||
- Client side mathematical expression parsing, courtesy of [MathJax](https://www.mathjax.org/)
|
- Client side mathematical expression parsing, courtesy of [MathJax](https://www.mathjax.org/)
|
||||||
|
- Links to non-existent pages appear red
|
||||||
- Internal links
|
- Internal links
|
||||||
- Links to non-existent pages show up in red
|
- Links to non-existent pages show up in red
|
||||||
- Printable page view
|
- Printable page view
|
||||||
|
|
@ -86,6 +87,8 @@ These commands are also in `build.sh`. You can run that if you want. Here's an e
|
||||||
## Configuring
|
## Configuring
|
||||||
To configure your new install, make sure that you've loaded the wiki in your browser at least once. Then open `peppermint.json` in your favourite text editor. An explanation of each of the settings can be found below. If you need any help, just contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new).
|
To configure your new install, make sure that you've loaded the wiki in your browser at least once. Then open `peppermint.json` in your favourite text editor. An explanation of each of the settings can be found below. If you need any help, just contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new).
|
||||||
|
|
||||||
|
Please note that configuration of Pepperminty Wiki will be done through a GUI soon.
|
||||||
|
|
||||||
Below are all the configuration directives that Pepperminty Wiki (and all the modules included in the repository) understand.
|
Below are all the configuration directives that Pepperminty Wiki (and all the modules included in the repository) understand.
|
||||||
|
|
||||||
Key | Value | Explanation
|
Key | Value | Explanation
|
||||||
|
|
@ -146,7 +149,7 @@ I've also documented Pepperminty Wiki's entire REST API using [apiDoc](http://ap
|
||||||
If you do create a module, I'd love to hear about it. Even better, [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls/new)!
|
If you do create a module, I'd love to hear about it. Even better, [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls/new)!
|
||||||
|
|
||||||
## Real World Usage
|
## Real World Usage
|
||||||
None yet! Contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I will add you to this section!
|
None yet! Contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I'll add you to this section!
|
||||||
|
|
||||||
## Todo
|
## 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!).
|
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!).
|
||||||
|
|
|
||||||
|
|
@ -305,7 +305,7 @@ Actions:
|
||||||
///////////////////////////////////////////////////////////////////////////////////////////////
|
///////////////////////////////////////////////////////////////////////////////////////////////
|
||||||
/////////////// Do not edit below this line unless you know what you are doing! ///////////////
|
/////////////// Do not edit below this line unless you know what you are doing! ///////////////
|
||||||
///////////////////////////////////////////////////////////////////////////////////////////////
|
///////////////////////////////////////////////////////////////////////////////////////////////
|
||||||
$version = "v0.12-beta1";
|
$version = "v0.12-beta2";
|
||||||
/// Environment ///
|
/// Environment ///
|
||||||
$env = new stdClass();
|
$env = new stdClass();
|
||||||
$env->action = $settings->defaultaction;
|
$env->action = $settings->defaultaction;
|
||||||
|
|
@ -1025,7 +1025,7 @@ class page_renderer
|
||||||
|
|
||||||
<footer>
|
<footer>
|
||||||
<p>{footer-message}</p>
|
<p>{footer-message}</p>
|
||||||
<p>Powered by Pepperminty Wiki v0.12-beta1, which was built by <a href='//starbeamrainbowlabs.com/'>Starbeamrainbowlabs</a>. Send bugs to 'bugs at starbeamrainbowlabs dot com' or <a href='//github.com/sbrl/Pepperminty-Wiki' title='Github Issue Tracker'>open an issue</a>.</p>
|
<p>Powered by Pepperminty Wiki v0.12-beta2, which was built by <a href='//starbeamrainbowlabs.com/'>Starbeamrainbowlabs</a>. Send bugs to 'bugs at starbeamrainbowlabs dot com' or <a href='//github.com/sbrl/Pepperminty-Wiki' title='Github Issue Tracker'>open an issue</a>.</p>
|
||||||
<p>Your local friendly administrators are {admins-name-list}.</p>
|
<p>Your local friendly administrators are {admins-name-list}.</p>
|
||||||
<p>This wiki is managed by <a href='mailto:{admin-details-email}'>{admin-details-name}</a>.</p>
|
<p>This wiki is managed by <a href='mailto:{admin-details-email}'>{admin-details-name}</a>.</p>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
@ -1037,7 +1037,7 @@ class page_renderer
|
||||||
<p><em>From {sitename}, which is managed by {admin-details-name}.</em></p>
|
<p><em>From {sitename}, which is managed by {admin-details-name}.</em></p>
|
||||||
<p>{footer-message}</p>
|
<p>{footer-message}</p>
|
||||||
<p><em>Timed at {generation-date}</em></p>
|
<p><em>Timed at {generation-date}</em></p>
|
||||||
<p><em>Powered by Pepperminty Wiki v0.12-beta1.</em></p>
|
<p><em>Powered by Pepperminty Wiki v0.12-beta2.</em></p>
|
||||||
</footer>";
|
</footer>";
|
||||||
|
|
||||||
// An array of functions that have been registered to process the
|
// An array of functions that have been registered to process the
|
||||||
|
|
@ -1092,7 +1092,7 @@ class page_renderer
|
||||||
"{body}" => $body_template,
|
"{body}" => $body_template,
|
||||||
|
|
||||||
"{sitename}" => $logo_html,
|
"{sitename}" => $logo_html,
|
||||||
"v0.12-beta1" => $version,
|
"v0.12-beta2" => $version,
|
||||||
"{favicon-url}" => $settings->favicon,
|
"{favicon-url}" => $settings->favicon,
|
||||||
"{header-html}" => self::get_header_html(),
|
"{header-html}" => self::get_header_html(),
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue