Skip to content

Commit

Permalink
Fix miscellaneous Markdown issues
Browse files Browse the repository at this point in the history
- Drop extension from relative links (see <https://vitepress.dev/guide/routing#linking-between-pages>)
- Place punctuation outside of links
- Change `command` code blocks to `mcfunction`
- Change `bash` code blocks to `sh`
- Avoid technical term in `/develop/sounds/using-sounds.md` title
- Fix weird escapes in some translated links
- `Codec&amp;amp;lt;Map&amp;amp;gt;` is getting out of hand
  • Loading branch information
its-miroma committed Jun 27, 2024
1 parent 3d4917e commit dedb892
Show file tree
Hide file tree
Showing 194 changed files with 587 additions and 593 deletions.
4 changes: 1 addition & 3 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
{
"markdownlint.lintWorkspaceGlobs": [
"**/*.{md,mkd,mdwn,mdown,markdown,markdn,mdtxt,mdtext,workbook}",
"!**/bower_components",
"**/*.md",
"!**/node_modules",
"!**/vendor",
"!**/.git",
"!versions/*/translated/**",
"!translated/**",
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ This repository contains the source code for the Fabric Documentation website, w

## Contributing

Please refer to the [contribution guidelines](./contributing.md) for more information.
Please refer to the [contribution guidelines](./contributing) for more information.
6 changes: 3 additions & 3 deletions develop/commands/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ We can use our custom argument type in a command - by passing an instance of it

Running the command, we can test whether or not the argument type works:

![Invalid argument.](/assets/develop/commands/custom-arguments_fail.png)
![Invalid argument](/assets/develop/commands/custom-arguments_fail.png)

![Valid argument.](/assets/develop/commands/custom-arguments_valid.png)
![Valid argument](/assets/develop/commands/custom-arguments_valid.png)

![Command result.](/assets/develop/commands/custom-arguments_result.png)
![Command result](/assets/develop/commands/custom-arguments_result.png)
2 changes: 1 addition & 1 deletion develop/commands/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Command<ServerCommandSource> command = context -> {
Commands are registered within the `CommandRegistrationCallback` provided by the Fabric API.

::: info
For information on registering callbacks, please see the [Events](../events.md) guide.
For information on registering callbacks, please see the [Events](../events) guide.
:::

The event should be registered in your mod's initializer.
Expand Down
2 changes: 1 addition & 1 deletion develop/entities/effects.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ Use the command `/effect give @p fabric-docs-reference:tater` to give the player
Use `/effect clear @p fabric-docs-reference:tater` to remove the effect.

::: info
To create a potion that uses this effect, please see the [Potions](../items/potions.md) guide.
To create a potion that uses this effect, please see the [Potions](../items/potions) guide.
:::
6 changes: 3 additions & 3 deletions develop/getting-started/creating-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Fabric provides an easy way to create a new mod project using the Fabric Templat

You can use the [Fabric Template Mod Generator](https://fabricmc.net/develop/template/) to generate a new project for your mod - you should fill in the required fields, such as the package name and mod name, and the Minecraft version that you want to develop for.

![Preview of the generator.](/assets/develop/getting-started/template-generator.png)
![Preview of the generator](/assets/develop/getting-started/template-generator.png)

If you want to use Kotlin, or want to add data generators, you can select the appropriate options in the `Advanced Options` section.

![Advanced options section.](/assets/develop/getting-started/template-generator-advanced.png)
![Advanced options section](/assets/develop/getting-started/template-generator-advanced.png)

Once you've filled in the required fields, click the `Generate` button, and the generator will create a new project for you to use in the form of a zip file.

Expand Down Expand Up @@ -45,7 +45,7 @@ If you cannot use the Fabric Template Mod Generator, you can create a new projec

Firstly, clone the example mod repository using Git:

```bash
```sh
git clone https://github.com/FabricMC/fabric-example-mod/ my-mod-project
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To start developing mods with Fabric, you will need to set up a development envi

To develop mods for Minecraft 1.20.4, you will need JDK 17.

If you need help installing Java, you can refer to the various Java installation guides in the [player guides section.](../../players/index.md)
If you need help installing Java, you can refer to the various Java installation guides in the [player guides section](../../players/index).

## Installing IntelliJ IDEA

Expand Down
2 changes: 1 addition & 1 deletion develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Our curated developer guides, written by the community, span a wide range of top

Take a look at the sidebar for a list of all the developer guides available. If you're looking for something specific, you can use the search bar at the top of the page to find what you need.

If you want to contribute to the Fabric Documentation, you can find the source code on [GitHub](https://github.com/FabricMC/fabric-docs), and the relevant [contribution guidelines.](../contributing.md)
If you want to contribute to the Fabric Documentation, you can find the source code on [GitHub](https://github.com/FabricMC/fabric-docs), and the relevant [contribution guidelines](../contributing).
2 changes: 1 addition & 1 deletion develop/items/potions.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ We pass an instance of `StatusEffectInstance`, which takes 3 parameters:
- `int amplifier` - An amplifier for the effect. For example, Haste II would have an amplifier of 1.

::: info
To create your own effect, please see the [Effects](../entities/effects.md) guide.
To create your own effect, please see the [Effects](../entities/effects) guide.
:::

### Registering the Potion
Expand Down
6 changes: 3 additions & 3 deletions develop/rendering/basic-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ We're going to draw vertices at the following points on the HUD (in order):

This should give us a lovely diamond - since we're using the `TRIANGLE_STRIP` draw mode, the renderer will perform the following steps:

![Four steps that show the placement of the vertices on the screen to form two triangles.](/assets/develop/rendering/concepts-practical-example-draw-process.png)
![Four steps that show the placement of the vertices on the screen to form two triangles](/assets/develop/rendering/concepts-practical-example-draw-process.png)

Since we're drawing on the HUD in this example, we'll use the `HudRenderCallback` event:

Expand Down Expand Up @@ -145,7 +145,7 @@ Make sure to push the matrix stack before you get a transformation matrix!

@[code lang=java transcludeWith=:::2](@/reference/latest/src/client/java/com/example/docs/rendering/RenderingConceptsEntrypoint.java)

![A video showing the diamond scaling up and down.](/assets/develop/rendering/concepts-matrix-stack.webp)
![A video showing the diamond scaling up and down](/assets/develop/rendering/concepts-matrix-stack.webp)

## Quaternions (Rotating Things)

Expand All @@ -159,4 +159,4 @@ Let's say we want to rotate our diamond around the z-axis. We can do this by usi

The result of this is the following:

![A video showing the diamond rotating around the z-axis.](/assets/develop/rendering/concepts-quaternions.webp)
![A video showing the diamond rotating around the z-axis](/assets/develop/rendering/concepts-quaternions.webp)
10 changes: 5 additions & 5 deletions develop/rendering/draw-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors:

# Using the Drawing Context

This page assumes you've taken a look at the [Basic Rendering Concepts](./basic-concepts.md) page.
This page assumes you've taken a look at the [Basic Rendering Concepts](./basic-concepts) page.

The `DrawContext` class is the main class used for rendering in the game. It is used for rendering shapes, text and textures, and as previously seen, used to manipulate `MatrixStack`s and use `BufferBuilder`s.

Expand All @@ -21,15 +21,15 @@ You can use the `DrawContext.fill(...)` method to draw a filled rectangle.

@[code lang=java transcludeWith=:::1](@/reference/latest/src/client/java/com/example/docs/rendering/DrawContextExampleScreen.java)

![A rectangle.](/assets/develop/rendering/draw-context-rectangle.png)
![A rectangle](/assets/develop/rendering/draw-context-rectangle.png)

### Drawing Outlines/Borders

Let's say we want to outline the rectangle we just drew. We can use the `DrawContext.drawBorder(...)` method to draw an outline.

@[code lang=java transcludeWith=:::2](@/reference/latest/src/client/java/com/example/docs/rendering/DrawContextExampleScreen.java)

![Rectangle with border.](/assets/develop/rendering/draw-context-rectangle-border.png)
![Rectangle with border](/assets/develop/rendering/draw-context-rectangle-border.png)

### Drawing Individual Lines

Expand All @@ -53,7 +53,7 @@ To enable the scissor manager, simply use the `DrawContext.enableScissor(...)` m

@[code lang=java transcludeWith=:::4](@/reference/latest/src/client/java/com/example/docs/rendering/DrawContextExampleScreen.java)

![Scissor region in action.](/assets/develop/rendering/draw-context-scissor.png)
![Scissor region in action](/assets/develop/rendering/draw-context-scissor.png)

As you can see, even though we tell the game to render the gradient across the entire screen, it only renders within the scissor region.

Expand All @@ -67,7 +67,7 @@ Generally, it's recommended that you use the overload that specifies the `textur

@[code lang=java transcludeWith=:::5](@/reference/latest/src/client/java/com/example/docs/rendering/DrawContextExampleScreen.java)

![Drawing whole texture example.](/assets/develop/rendering/draw-context-whole-texture.png)
![Drawing whole texture example](/assets/develop/rendering/draw-context-whole-texture.png)

### Drawing a Portion of a Texture

Expand Down
2 changes: 1 addition & 1 deletion develop/rendering/gui/custom-widgets.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Like all widgets, you need to add it to the screen using the `addDrawableChild`

@[code lang=java transcludeWith=:::3](@/reference/latest/src/client/java/com/example/docs/rendering/screens/CustomScreen.java)

![Custom widget on screen.](/assets/develop/rendering/gui/custom-widget-example.png)
![Custom widget on screen](/assets/develop/rendering/gui/custom-widget-example.png)

## Widget Events

Expand Down
4 changes: 2 additions & 2 deletions develop/rendering/hud.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors:

# Rendering in the Hud

We already briefly touched on rendering things to the hud in the [Basic Rendering Concepts](./basic-concepts.md) page and [Using The Drawing Context](./draw-context.md), so on this page we'll stick to the `HudRenderCallback` event and the `deltaTick` parameter.
We already briefly touched on rendering things to the hud in the [Basic Rendering Concepts](./basic-concepts) page and [Using The Drawing Context](./draw-context), so on this page we'll stick to the `HudRenderCallback` event and the `deltaTick` parameter.

## HudRenderCallback

Expand All @@ -17,7 +17,7 @@ To register to this event, you can simply call `HudRenderCallback.EVENT.register

The draw context can be used to access the various rendering utilities provided by the game, and access the raw matrix stack.

You should check out the [Draw Context](./draw-context.md) page to learn more about the draw context.
You should check out the [Draw Context](./draw-context) page to learn more about the draw context.

### DeltaTick

Expand Down
2 changes: 1 addition & 1 deletion develop/rendering/particles/creating-particles.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Once you have completed the JSON file and saved your work, you are good to load

You can see if everything has worked by typing the following command:

```command
```mcfunction
/particle <mod id here>:sparkle_particle ~ ~1 ~
```

Expand Down
2 changes: 1 addition & 1 deletion develop/sounds/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ This way, the `ModInitializer` implementing entrypoint class needs to only imple

## Using the Custom SoundEvent

Use the helper class to access the custom SoundEvent. Checkout the [Playing SoundEvents](./using-sounds.md) page to learn how to play sounds.
Use the helper class to access the custom SoundEvent. Checkout the [Playing SoundEvents](./using-sounds) page to learn how to play sounds.
6 changes: 3 additions & 3 deletions develop/sounds/using-sounds.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Playing SoundEvents
title: Playing Sounds
description: Learn how to play sound events.
---

# Playing SoundEvents
# Playing Sounds

Minecraft has a big selection of sounds which you can choose from. Check out the `SoundEvents` class to view all the vanilla sound event instances that Mojang has provided.

Expand All @@ -21,7 +21,7 @@ The `playSound()` method is used with the `LivingEntity` object. Only the SoundE

### SoundEvent and SoundCategory

The SoundEvent defines which sound will be played. You can also [register your own SoundEvents](./custom.md) to include your own sound.
The SoundEvent defines which sound will be played. You can also [register your own SoundEvents](./custom) to include your own sound.

Minecraft has several audio sliders in the in-game settings. The `SoundCategory` enum is used to determine which slider will adjust your sound's volume.

Expand Down
6 changes: 3 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ features:
- title: Developer Guides
icon: 🛠️
details: Our curated developer guides, written by the community, span a wide range of topics from setting up a development environment to more advanced topics, such as rendering and networking.
link: ./develop/index.md
link: ./develop/index
linkText: Get Started
- title: Player Guides
icon: 📚
details: Are you a player looking to use mods powered by Fabric? Our player guides have you covered. These guides will help you in downloading, installing, and troubleshooting Fabric mods.
link: ./players/index.md
link: ./players/index
linkText: Read More
---

<div class="vp-doc homepage-container">

## Want to Contribute?

If you want to contribute to the Fabric Documentation, you can find the source code on [GitHub](https://github.com/FabricMC/fabric-docs), and the relevant [contribution guidelines.](./contributing.md)
If you want to contribute to the Fabric Documentation, you can find the source code on [GitHub](https://github.com/FabricMC/fabric-docs), and the relevant [contribution guidelines](./contributing).

</div>
2 changes: 1 addition & 1 deletion players/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Officially, Fabric supports all versions of Minecraft starting from snapshots `1
### Where Can I Download Published Fabric Mods?

::: info
You should always check if mods are from a trustworthy source. Check out the [Finding Trustworthy Mods](./finding-mods.md) guide for more information.
You should always check if mods are from a trustworthy source. Check out the [Finding Trustworthy Mods](./finding-mods) guide for more information.
:::

The majority of authors publish their mods to [Modrinth](https://modrinth.com/mods?g=categories:%27fabric%27) and [CurseForge](https://www.curseforge.com/minecraft/search?class=mc-mods&gameVersionTypeId=4), however some may choose to upload them on their personal websites, or on other platforms, such as a GitHub repository.
Expand Down
8 changes: 4 additions & 4 deletions players/installing-fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ Close Minecraft and the Minecraft Launcher first before installing.

On macOS, you may need to right click the `.jar` file in your downloads directory and click `Open` to run it.

![MacOS context menu on Fabric Installer.](/assets/players/installing-fabric/macos-downloads.png)
![MacOS context menu on Fabric Installer](/assets/players/installing-fabric/macos-downloads.png)

When asked "Are you sure you want to open it?", click `Open` again.
:::

Once you've opened the installer, you should see a screen like this:

![Fabric Installer with "Install" highlighted.](/assets/players/installing-fabric/installer-screen.png)
![Fabric Installer with "Install" highlighted](/assets/players/installing-fabric/installer-screen.png)

To install Fabric, simply choose your game version from the dropdown, and click `Install`.

Expand All @@ -46,10 +46,10 @@ To install Fabric, simply choose your game version from the dropdown, and click

Once the installer has finished, you can open the Minecraft Launcher and select the Fabric profile from the dropdown in the bottom left corner and press Play!

![Minecraft Launcher with Fabric profile selected.](/assets/players/installing-fabric/launcher-screen.png)
![Minecraft Launcher with Fabric profile selected](/assets/players/installing-fabric/launcher-screen.png)

## Next Steps

Now that you've installed Fabric, you can add mods to your game! Check out the [Finding Trustworthy Mods](./finding-mods.md) guide for more information.
Now that you've installed Fabric, you can add mods to your game! Check out the [Finding Trustworthy Mods](./finding-mods) guide for more information.

If you encounter any issues while following this guide, you can ask for help in the [Fabric Discord](https://discord.gg/v6v4pMv) in the `#player-support` channel.
18 changes: 9 additions & 9 deletions players/installing-java/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide will walk you through installing Java 17 on Linux.

Open a terminal, type `java -version`, and press <kbd>Enter</kbd>.

![Terminal with "java -version" typed in.](/assets/players/installing-java/linux-java-version.png)
![Terminal with "java -version" typed in](/assets/players/installing-java/linux-java-version.png)

::: warning
To use the majority of modern Minecraft versions, you'll need at least Java 17 installed. If this command displays any version lower than 17, you'll need to update your existing Java installation.
Expand All @@ -31,27 +31,27 @@ For more information on installing Java on Arch Linux, see the [Arch Linux Wiki]

You can install the latest JRE from the official repositories:

```bash
```sh
sudo pacman -S jre-openjdk
```

If you're running a server without the need for a graphical interface, you can install the headless version instead:

```bash
```sh
sudo pacman -S jre-openjdk-headless
```

If you plan to develop mods, you'll need the JDK instead:

```bash
```sh
sudo pacman -S jdk-openjdk
```

### Debian/Ubuntu

You can install Java 17 using `apt` with the following commands:

```bash
```sh
sudo apt update
sudo apt install openjdk-17-jdk
```
Expand All @@ -60,19 +60,19 @@ sudo apt install openjdk-17-jdk

You can install Java 17 using `dnf` with the following commands:

```bash
```sh
sudo dnf install java-17-openjdk
```

If you don't need a graphical interface, you can install the headless version instead:

```bash
```sh
sudo dnf install java-17-openjdk-headless
```

If you plan to develop mods, you'll need the JDK instead:

```bash
```sh
sudo dnf install java-17-openjdk-devel
```

Expand All @@ -88,4 +88,4 @@ Once the installation is complete, you can verify that Java 17 is installed by o

If the command runs successfully, you will see something like shown before, where the Java version is displayed:

![Terminal with "java -version" typed in.](/assets/players/installing-java/linux-java-version.png)
![Terminal with "java -version" typed in](/assets/players/installing-java/linux-java-version.png)
10 changes: 5 additions & 5 deletions players/installing-java/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ To check if Java is already installed, you must first open the command prompt.

You can do this by pressing <kbd>Win</kbd> + <kbd>R</kbd> and typing `cmd.exe` into the box that appears.

![Windows Run Dialog with "cmd.exe" in the run bar.](/assets/players/installing-java/windows-run-dialog.png)
![Windows Run Dialog with "cmd.exe" in the run bar](/assets/players/installing-java/windows-run-dialog.png)

Once you have opened the command prompt, type `java -version` and press <kbd>Enter</kbd>.

If the command runs successfully, you will see something like this. If the command failed, proceed to the next step.

![Command prompt with "java -version" typed in.](/assets/players/installing-java/windows-java-version.png)
![Command prompt with "java -version" typed in](/assets/players/installing-java/windows-java-version.png)

::: warning
To use the majority of modern Minecraft versions, you'll need at least Java 17 installed. If this command displays any version lower than 17, you'll need to update your existing Java installation.
Expand All @@ -35,7 +35,7 @@ To install Java 17, you'll need to download the installer from [Adoptium](https:

You'll want to download the `Windows Installer (.msi)` version:

![Adoptium download page with Windows Installer (.msi) highlighted.](/assets/players/installing-java/windows-download-java.png)
![Adoptium download page with Windows Installer (.msi) highlighted](/assets/players/installing-java/windows-download-java.png)

You should choose `x86` if you have a 32-bit operating system, or `x64` if you have a 64-bit operating system.

Expand All @@ -48,7 +48,7 @@ Follow the steps in the installer to install Java 17. When you reach this page,
- `Set JAVA_HOME environment variable` - This will be added to your PATH.
- `JavaSoft (Oracle) registry keys`

![Java 17 installer with "Set JAVA_HOME variable" and "JavaSoft (Oracle) registry keys" highlighted.](/assets/players/installing-java/windows-wizard-screenshot.png)
![Java 17 installer with "Set JAVA_HOME variable" and "JavaSoft (Oracle) registry keys" highlighted](/assets/players/installing-java/windows-wizard-screenshot.png)

Once you've done that, you can click `Next` and continue with the installation.

Expand All @@ -58,7 +58,7 @@ Once the installation is complete, you can verify that Java 17 is installed by o

If the command runs successfully, you will see something like shown before, where the Java version is displayed:

![Command prompt with "java -version" typed in.](/assets/players/installing-java/windows-java-version.png)
![Command prompt with "java -version" typed in](/assets/players/installing-java/windows-java-version.png)

---

Expand Down
Loading

0 comments on commit dedb892

Please sign in to comment.