SpigotMC-Mirrors/PlaceholderAPI
1
0
Fork 0
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI synced 2025-02-05 15:55:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Final push for wiki

Browse Source
This commit is contained in:
Andre601 2024-01-26 14:20:49 +01:00
parent e3980cf574
commit 7f39f06b39
No known key found for this signature in database
GPG Key ID: 90E82BD59347A86C
4 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/CNAME Normal file
View File

@ -0,0 +1 @@
wiki.placeholderapi.com

12
docs/developers/using-placeholderapi.md
View File

@ -11,9 +11,10 @@ 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.
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" }
<repositories>
<repository>
<id>placeholderapi</id>
@ -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.

4
mkdocs.yml
View File

@ -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

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
mkdocs-material==9.5.5