diff --git a/.theme/main.html b/.theme/main.html new file mode 100644 index 0000000..2bde044 --- /dev/null +++ b/.theme/main.html @@ -0,0 +1,41 @@ +{% extends "base.html" %} + +{% block extrahead %} + {% if page and page.meta %} + {% set title = config.site_name %} + {% if page.meta.title %} + + + {% elif page.title and not page.is_homepage %} + + + {% else %} + + + {% endif %} + + {% if page.meta.description %} + + + {% else %} + + + {% endif %} + {% endif %} + + + + + + + + + + + + + + + + +{% endblock %} \ No newline at end of file diff --git a/docs/.footer.md b/docs/.footer.md deleted file mode 100644 index 05a1a92..0000000 --- a/docs/.footer.md +++ /dev/null @@ -1,23 +0,0 @@ -[papi]: https://placeholderapi.com - -[discordImg]: https://img.shields.io/discord/164280494874165248.svg?logo=discord&label=Discord&colorB=7289DA -[discord]: https://helpch.at/discord - -[jenkinsImg]: https://img.shields.io/badge/Download%20from-Jenkins-brightgreen.svg -[jenkins]: http://ci.extendedclip.com/job/PlaceholderAPI/ - -[licenseImg]: https://img.shields.io/github/license/PlaceholderAPI/PlaceholderAPI.svg -[license]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/LICENSE - -[issuesImg]: https://img.shields.io/github/issues-raw/PlaceholderAPI/PlaceholderAPI.svg?logo=github&logoColor=white -[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues - -[versionImg]: https://img.shields.io/nexus/placeholderapi/me.clip/placeholderapi?server=https%3A%2F%2Frepo.extendedclip.com&label=API%20Version -[plugin-page]: https://spigotmc.org/resources/6245 - -> © 2015 - 2023 [PlaceholderAPI Team][papi] -> Thanks for using PlaceholderAPI. -> -> **[Plugin-page]** | **[[Placeholders]]** | **[[Plugins using PlaceholderAPI]]** | **[[Hook into PlaceholderAPI]]** -> -> ![versionImg] [![jenkinsImg]][jenkins] [![licenseImg]][license] [![issuesImg]][issues] [![discordImg]][discord] diff --git a/docs/.sidebar.md b/docs/.sidebar.md deleted file mode 100644 index dccd719..0000000 --- a/docs/.sidebar.md +++ /dev/null @@ -1,79 +0,0 @@ -

- PlaceholderAPI -

- -**[[Main page|Home]]** - -### Setup -**[[Using Placeholders]]** -**[[Hook into PlaceholderAPI]]** -- [[First steps|Hook-into-PlaceholderAPI#first-steps]] -- [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]] - - [[Common Parts|PlaceholderExpansion#common-parts]] - - [[Without an external plugin|PlaceholderExpansion#without-a-plugin]] - - [[With an external Plugin (Separate Jar)|PlaceholderExpansion#with-a-plugin-external-jar]] - - [[With an external Plugin (Internal class)|PlaceholderExpansion#with-a-plugin-internal-class]] - - [[Relational Placeholders|PlaceholderExpansion#relational-placeholders]] -- [[Setting placeholders in your plugin|Hook-into-PlaceholderAPI#setting-placeholders-in-your-plugin]] - -### Other -**[[Commands]]** -**[[Expansion cloud]]** -**[[FAQ]]** -**[[Common Issues]]** -**[[Plugins using PlaceholderAPI]]** -**[[Placeholders]]** -- [[Standalone|Placeholders#standalone]] - - [[A|Placeholders#a]] - - [[B|Placeholders#b]] - - [[C|Placeholders#c]] - - [[D|Placeholders#d]] - - [[E|Placeholders#e]] - - [[F|Placeholders#f]] - - [[G|Placeholders#g]] - - [[H|Placeholders#h]] - - [[I|Placeholders#i]] - - [[J|Placeholders#j]] - - [[K|Placeholders#k]] - - [[L|Placeholders#l]] - - [[M|Placeholders#m]] - - [[N|Placeholders#n]] - - [[O|Placeholders#o]] - - [[P|Placeholders#p]] - - [[Q|Placeholders#q]] - - [[R|Placeholders#r]] - - [[S|Placeholders#s]] - - [[T|Placeholders#t]] - - [[U|Placeholders#u]] - - [[V|Placeholders#v]] - - [[W|Placeholders#w]] - - [[X|Placeholders#x]] - - [[Y|Placeholders#y]] - - [[Z|Placeholders#z]] -- [[Plugin-placeholders|Placeholders#plugin-placeholders-1]] - - [[A|Placeholders#a-1]] - - [[B|Placeholders#b-1]] - - [[C|Placeholders#c-1]] - - [[D|Placeholders#d-1]] - - [[E|Placeholders#e-1]] - - [[F|Placeholders#f-1]] - - [[G|Placeholders#g-1]] - - [[H|Placeholders#h-1]] - - [[I|Placeholders#i-1]] - - [[J|Placeholders#j-1]] - - [[K|Placeholders#k-1]] - - [[L|Placeholders#l-1]] - - [[M|Placeholders#m-1]] - - [[N|Placeholders#n-1]] - - [[O|Placeholders#o-1]] - - [[P|Placeholders#p-1]] - - [[Q|Placeholders#q-1]] - - [[R|Placeholders#r-1]] - - [[S|Placeholders#s-1]] - - [[T|Placeholders#t-1]] - - [[U|Placeholders#u-1]] - - [[V|Placeholders#v-1]] - - [[W|Placeholders#w-1]] - - [[X|Placeholders#x-1]] - - [[Y|Placeholders#y-1]] - - [[Z|Placeholders#z-1]] diff --git a/docs/assets/img/favicons/android-chrome-192x192.png b/docs/assets/img/favicons/android-chrome-192x192.png new file mode 100644 index 0000000..799574e Binary files /dev/null and b/docs/assets/img/favicons/android-chrome-192x192.png differ diff --git a/docs/assets/img/favicons/android-chrome-512x512.png b/docs/assets/img/favicons/android-chrome-512x512.png new file mode 100644 index 0000000..c4bd0c8 Binary files /dev/null and b/docs/assets/img/favicons/android-chrome-512x512.png differ diff --git a/docs/assets/img/favicons/apple-touch-icon.png b/docs/assets/img/favicons/apple-touch-icon.png new file mode 100644 index 0000000..d11407a Binary files /dev/null and b/docs/assets/img/favicons/apple-touch-icon.png differ diff --git a/docs/assets/img/favicons/favicon-16x16.png b/docs/assets/img/favicons/favicon-16x16.png new file mode 100644 index 0000000..7ab2e5d Binary files /dev/null and b/docs/assets/img/favicons/favicon-16x16.png differ diff --git a/docs/assets/img/favicons/favicon-32x32.png b/docs/assets/img/favicons/favicon-32x32.png new file mode 100644 index 0000000..8bb921a Binary files /dev/null and b/docs/assets/img/favicons/favicon-32x32.png differ diff --git a/docs/assets/img/favicons/favicon.ico b/docs/assets/img/favicons/favicon.ico new file mode 100644 index 0000000..fc06569 Binary files /dev/null and b/docs/assets/img/favicons/favicon.ico differ diff --git a/docs/assets/img/icon.png b/docs/assets/img/icon.png deleted file mode 100644 index 750505d..0000000 Binary files a/docs/assets/img/icon.png and /dev/null differ diff --git a/docs/assets/site.webmanifest b/docs/assets/site.webmanifest new file mode 100644 index 0000000..882098f --- /dev/null +++ b/docs/assets/site.webmanifest @@ -0,0 +1 @@ +{"name":"","short_name":"","icons":[{"src":"./img/favicons/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"./img/favicons/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/docs/commands.md b/docs/commands.md index 31a5718..7c34898 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,3 +1,7 @@ +--- +description: Available commands within PlaceholderAPI. +--- + # Commands This page shows all commands, including with a detailed description of what every command does. diff --git a/docs/common-issues.md b/docs/common-issues.md index 8ac1ba7..e1ccab5 100644 --- a/docs/common-issues.md +++ b/docs/common-issues.md @@ -1,3 +1,7 @@ +--- +description: List of common issues and how to solve them. +--- + # Common Issues This page lists common issues you may encounter with PlaceholderAPI and how you can solve them. diff --git a/docs/developers/creating-a-placeholderexpansion.md b/docs/developers/creating-a-placeholderexpansion.md index 0996a32..f7b4ac5 100644 --- a/docs/developers/creating-a-placeholderexpansion.md +++ b/docs/developers/creating-a-placeholderexpansion.md @@ -1,3 +1,7 @@ +--- +description: Comprehensive guide on how to create a PlaceholderExpansion for other plugins to use through PlaceholderAPI. +--- + # Creating a PlaceholderExpansion This page will cover how you can create your own [`PlaceholderExpansion`][placeholderexpansion] which you can either integrate into your own plugin (Recommended) or [upload to the eCloud](expansion-cloud.md). diff --git a/docs/developers/expansion-cloud.md b/docs/developers/expansion-cloud.md index a00e9e4..7265381 100644 --- a/docs/developers/expansion-cloud.md +++ b/docs/developers/expansion-cloud.md @@ -1,3 +1,7 @@ +--- +description: Information about PlaceholderAPI's expansion cloud, including how to submit your own expansion or update it. +--- + # eCloud ## About diff --git a/docs/developers/using-placeholderapi.md b/docs/developers/using-placeholderapi.md index d4f7317..340ab67 100644 --- a/docs/developers/using-placeholderapi.md +++ b/docs/developers/using-placeholderapi.md @@ -1,3 +1,7 @@ +--- +description: Guide on how to use PlaceholderAPI in your own plugin. +--- + # Using PlaceholderAPI This page is about using PlaceholderAPI in your own plugin, to either let other plugins use your plugin, or just use placeholders from other plugins in your own. diff --git a/docs/faq.md b/docs/faq.md index 7097e49..99064bb 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,7 @@ +--- +description: List of frequently asked questions and their answers. +--- + # FAQ Here are frequently asked questions about stuff related to PlaceholderAPI. diff --git a/docs/index.md b/docs/index.md index d5d41d1..cb921ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +# Welcome + ![placeholderapi_logo](assets/img/wiki-logo.png){ align="center" } This wiki gives you information on how to create placeholders in your plugin that can be used in other plugins, how to use other placeholders inside your plugin, or how to make an expansion. diff --git a/docs/users/placeholder-list.md b/docs/users/placeholder-list.md index 20a50b7..9b3ae2e 100644 --- a/docs/users/placeholder-list.md +++ b/docs/users/placeholder-list.md @@ -1,3 +1,7 @@ +--- +description: Community-curated list of available PlaceholderExpansions and their placeholders. +--- + # Placeholder List This is a list of all available placeholders. diff --git a/docs/users/plugins-using-placeholderapi.md b/docs/users/plugins-using-placeholderapi.md index bd7e788..90c609a 100644 --- a/docs/users/plugins-using-placeholderapi.md +++ b/docs/users/plugins-using-placeholderapi.md @@ -1,3 +1,7 @@ +--- +description: List of Plugins that support PlaceholderAPI and/or provide their own placeholders to use. +--- + # Plugins using PlaceholderAPI This here is a list of all plugins supporting PlaceholderAPI by either having their own placeholders added, or just allowing other placeholders to be used. diff --git a/docs/users/using-placeholders.md b/docs/users/using-placeholders.md index 97ca79d..511df21 100644 --- a/docs/users/using-placeholders.md +++ b/docs/users/using-placeholders.md @@ -1,3 +1,7 @@ +--- +description: User Guide on how to use placeholders in a plugin. +--- + # Using Placeholders This page is intended for server owners or server staff who want to learn how to use placeholders in a plugin. diff --git a/mkdocs.yml b/mkdocs.yml index 5b54afe..c7e5aef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,8 +17,8 @@ repo_url: https://github.com/PlaceholderAPI/PlaceholderAPI theme: name: material - logo: assets/img/icon.png - favicon: assets/img/icon.png + custom_dir: '.theme' + logo: assets/img/favicons/android-chrome-512x512.png icon: admonition: note: octicons/pencil-16