diff --git a/peppermint-config-info.php b/peppermint-config-info.php new file mode 100644 index 0000000..014b68a --- /dev/null +++ b/peppermint-config-info.php @@ -0,0 +1,114 @@ + + +
+ +peppermint.json
Configuration GuideThis page contains a comprehensive guide to all the settings present in peppermint.json
. If anything's missing or unclear, please open an issue!
Type | +Meaning | +
---|---|
text |
+ A string of text, which may or may or may not allow HTML. Consult individual descriptions for more specific information. | +
textarea |
+ A longer string of text that may or may not allow HTML. | +
array |
+ An array of strings. | +
url |
+ A url to a remote resource. | +
checkbox |
+ A boolean value - i.e. either true or false . |
+
email |
+ An email address. | +
number |
+ A numerical value that may or may not be floating-point. | +
usertable |
+ An object that contains the users' usernames and passwords. | +
nav |
+ A complex array of items that should appear as a navigation bar. Consult the description for nav_links for more information. |
+
map |
+ An object that maps a set of values onto another set of values. | +
Key | +Type | +Description | +Default Value | +
---|---|---|---|
$config_key | ");
+ echo("$config_info->type | ");
+ echo("$config_info->description | "); + echo("
| ");
+ echo("