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 guide + + +

peppermint.json Configuration Guide

+

This page contains a comprehensive guide to all the settings present in peppermint.json. If anything's missing or unclear, please open an issue!

+ +

Type Legend

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeMeaning
textA string of text, which may or may or may not allow HTML. Consult individual descriptions for more specific information.
textareaA longer string of text that may or may not allow HTML.
arrayAn array of strings.
urlA url to a remote resource.
checkboxA boolean value - i.e. either true or false.
emailAn email address.
numberA numerical value that may or may not be floating-point.
usertableAn object that contains the users' usernames and passwords.
navA complex array of items that should appear as a navigation bar. Consult the description for nav_links for more information.
mapAn object that maps a set of values onto another set of values.
+ +
+ + +

Configuration Guide

+ + + + + + + + + + + + + + + + + + $config_info) { + echo(""); + echo(""); + echo(""); + echo(""); + echo(""); + echo("\n"); + } + ?> + +
KeyTypeDescriptionDefault Value
$config_key$config_info->type$config_info->description
" . json_encode($config_info->default, true) . "
+ + + + + + + +