From 7f39f06b3900d7f9534a5485244dd822752abab2 Mon Sep 17 00:00:00 2001 From: Andre601 Date: Fri, 26 Jan 2024 14:20:49 +0100 Subject: [PATCH] Final push for wiki --- docs/CNAME | 1 + docs/developers/using-placeholderapi.md | 14 ++++++++++++-- mkdocs.yml | 4 +--- requirements.txt | 1 + 4 files changed, 15 insertions(+), 5 deletions(-) create mode 100644 docs/CNAME create mode 100644 requirements.txt diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..ed1a18d --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +wiki.placeholderapi.com \ No newline at end of file diff --git a/docs/developers/using-placeholderapi.md b/docs/developers/using-placeholderapi.md index 46ae8d8..c65b9b3 100644 --- a/docs/developers/using-placeholderapi.md +++ b/docs/developers/using-placeholderapi.md @@ -10,10 +10,11 @@ Please note, that the examples in this page are only available for **Placeholder ## First steps -Before you can actually make use of PlaceholderAPI, you first have to import it into your project. +Before you can actually make use of PlaceholderAPI, you first have to import it into your project. +Use the below code example matching your dependency manager. /// tab | :simple-apachemaven: Maven -```{ .xml title="pom.xml" data-md-component="api-version" } +```{ .xml .annotate title="pom.xml" data-md-component="api-version" } placeholderapi @@ -45,6 +46,15 @@ dependencies { ``` /// +/// details | What is `{version}`? + type: question + +Using Javascript, `{version}` is replaced with the latest available API version of PlaceholderAPI. +Should you see the placeholder as-is does it mean that you either block Javascript, or that the version couldn't be obtained in time during page load. + +You can always find the latest version matching the API version on the [releases tab](https://github.com/PlaceholderAPI/PlaceholderAPI/releases) of the GitHub Repository. +/// + ### Set PlaceholderAPI as (soft)depend Next step is to go to your plugin.yml or paper-plugin.yml and add PlaceholderAPI as a depend or softdepend, depending (no pun intended) on if it is optional or not. diff --git a/mkdocs.yml b/mkdocs.yml index 668e43e..a34887a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,9 +2,7 @@ site_name: PlaceholderAPI Wiki site_description: Wiki of the Spigot Plugin PlaceholderAPI. site_author: PlaceholderAPI Team and Contributors -#site_url: 'https://wiki.placeholderapi.com' # Maybe? - -site_url: https://docs.andre601.ch/PlaceholderAPI # Temp until final decision and possible push to upstream +site_url: 'https://wiki.placeholderapi.com' repo_name: PlaceholderAPI/PlaceholderAPI repo_url: https://github.com/PlaceholderAPI/PlaceholderAPI diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8a97be7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material==9.5.5 \ No newline at end of file