Skip to content

Commit

Permalink
fix: remove the placeholder plugin
Browse files Browse the repository at this point in the history
it breaks literally everything at once
  • Loading branch information
Citymonstret committed Dec 22, 2023
1 parent e70740d commit 125ee3b
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 27 deletions.
16 changes: 8 additions & 8 deletions docs/annotations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The module can also function as an [annotation processor](#annotation-processing
There are extensions to `cloud-annotations` for Kotlin, more information [here](../kotlin/annotations.md).

Examples can be found on
[GitHub](https://github.com/Incendo/cloud/tree/iCLOUD_BASE_BRANCHi/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations)
[GitHub](https://github.com/Incendo/cloud/tree/2.0.0-dev/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations)

## Installation

Expand All @@ -22,7 +22,7 @@ Cloud Annotations is available through [Maven Central](https://search.maven.org/
<dependency>
<groupId>cloud.commandframework</groupId>
<artifactId>cloud-annotations</artifactId>
<version>dCLOUD_BASE_VERSIONd</version>
<version>2.0.0-SNAPSHOT</version>
</dependency>
</dependencies>

Expand All @@ -37,7 +37,7 @@ Cloud Annotations is available through [Maven Central](https://search.maven.org/
<path>
<groupId>cloud.commandframework</groupId>
<artifactId>cloud-annotations</artifactId>
<version>dCLOUD_BASE_VERSIONd</version>
<version>2.0.0-SNAPSHOT</version>
</path>
</annotationProcessorPaths>
</configuration>
Expand All @@ -49,17 +49,17 @@ Cloud Annotations is available through [Maven Central](https://search.maven.org/
=== "Gradle (Kotlin)"

```kotlin
implementation("cloud.commandframework:cloud-annotations:dCLOUD_BASE_VERSIONd")
implementation("cloud.commandframework:cloud-annotations:2.0.0-SNAPSHOT")
// Optional:
annotationProcessor("cloud.commandframework:cloud-annotations:dCLOUD_BASE_VERSIONd")
annotationProcessor("cloud.commandframework:cloud-annotations:2.0.0-SNAPSHOT")
```

=== "Gradle (Groovy)"

```groovy
implementation 'cloud.commandframework:cloud-annotations:dCLOUD_BASE_VERSIONd'
implementation 'cloud.commandframework:cloud-annotations:2.0.0-SNAPSHOT'
// Optional:
annotationProcessor 'cloud.commandframework:cloud-annotations:dCLOUD_BASE_VERSIONd'
annotationProcessor 'cloud.commandframework:cloud-annotations:2.0.0-SNAPSHOT'
```

You then need to create an `AnnotationParser` instance.
Expand Down Expand Up @@ -250,7 +250,7 @@ manager.parameterInjectorRegistry().registerInjector(
```

Cloud has an injection service implementation for Guice:
[GuiceInjectionService](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/cloud-core/src/main/java/cloud/commandframework/annotations/injection/GuiceInjectionService.java).
[GuiceInjectionService](https://github.com/Incendo/cloud/blob/2.0.0-dev/cloud-core/src/main/java/cloud/commandframework/annotations/injection/GuiceInjectionService.java).
You may register injection services to the parameter registry using

```java
Expand Down
16 changes: 8 additions & 8 deletions docs/core/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ Cloud is available through [Maven Central](https://search.maven.org/search?q=clo
<dependency>
<groupId>cloud.commandframework</groupId>
<artifactId>cloud-core</artifactId>
<version>dCLOUD_BASE_VERSIONd</version>
<version>2.0.0-SNAPSHOT</version>
</dependency>
```

=== "Gradle (Kotlin)"

```kotlin
implementation("cloud.commandframework:cloud-core:dCLOUD_BASE_VERSIONd")
implementation("cloud.commandframework:cloud-core:2.0.0-SNAPSHOT")
```

=== "Gradle (Groovy)"

```groovy
implementation 'cloud.commandframework:cloud-core:dCLOUD_BASE_VERSIONd'
implementation 'cloud.commandframework:cloud-core:2.0.0-SNAPSHOT'
```

## Command
Expand Down Expand Up @@ -236,7 +236,7 @@ This allows you to easily add input validation to existing parsers.

Cloud has a built-in processor that validates the input using a regular expression.
You can find it here:
[RegexPreprocessor](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/cloud-core/src/main/java/cloud/commandframework/arguments/preprocessor/RegexPreprocessor.java)
[RegexPreprocessor](https://github.com/Incendo/cloud/blob/2.0.0-dev/cloud-core/src/main/java/cloud/commandframework/arguments/preprocessor/RegexPreprocessor.java)

#### Command context

Expand Down Expand Up @@ -621,8 +621,8 @@ Cloud has a [preprocessor](#pre---postprocessing) that allows you to create comm
an extra confirmation.

You can find examples of how make use of this system on GitHub, for either
[Builders](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/builder/feature/ConfirmationExample.java) or
[Annotations](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations/feature/ConfirmationExample.java).
[Builders](https://github.com/Incendo/cloud/blob/2.0.0-dev/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/builder/feature/ConfirmationExample.java) or
[Annotations](https://github.com/Incendo/cloud/blob/2.0.0-dev/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations/feature/ConfirmationExample.java).

### Help generation

Expand All @@ -645,5 +645,5 @@ The help handler does not display any information, this is instead done by a `He
but `cloud-minecraft-extras` contains an opinionated implementation of the help system for Minecraft.

You can find examples on GitHub for either
[Builders](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/builder/feature/HelpExample.java) or
[Annotations](https://github.com/Incendo/cloud/blob/iCLOUD_BASE_BRANCHi/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations/feature/HelpExample.java).
[Builders](https://github.com/Incendo/cloud/blob/2.0.0-dev/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/builder/feature/HelpExample.java) or
[Annotations](https://github.com/Incendo/cloud/blob/2.0.0-dev/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations/feature/HelpExample.java).
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For technical details, we ask you to look at the [JavaDoc](https://javadocs.dev/

We have a set of examples that introduce some useful Cloud concepts.
They are written for the Bukkit Minecraft API but the examples are not specific to Minecraft:
[example-bukkit](https://github.com/Incendo/cloud/tree/iCLOUD_BASE_BRANCHi/examples/example-bukkit).
[example-bukkit](https://github.com/Incendo/cloud/tree/2.0.0-dev/examples/example-bukkit).

## Structure

Expand Down
1 change: 0 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
mkdocs
mkdocs-material
mkdocs-placeholder-plugin
mkdocs-git-revision-date-localized-plugin
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ markdown_extensions:
- md_in_html
plugins:
- search
- placeholder
- git-revision-date-localized:
enable_creation_date: false
fallback_to_build_date: true
Expand Down
8 changes: 0 additions & 8 deletions placeholder-plugin.yaml

This file was deleted.

0 comments on commit 125ee3b

Please sign in to comment.