fix: apply vuejs/vitepress#5014 (#529)

* chore: migrate to pnpm

* chore: set minimumReleaseAge to 3 days

* feat: apply vuejs/vitepress#5014

* fix: transclusions from #415

Author: its-miroma

.github/CODEOWNERS

@@ -5,4 +5,5 @@
 crowdin.yaml       @FabricMC/developers
 netlify.toml       @FabricMC/developers
 package.json       @FabricMC/developers
-package-lock.json  @FabricMC/developers
+patches            @FabricMC/developers
+pnpm-*.yaml        @FabricMC/developers

.github/workflows/build.yaml

@@ -21,8 +21,10 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
-      - run: npm ci
-      - run: npm run build
+      - uses: pnpm/action-setup@58e6119fe4f3092a76a7771efb55e04d25b6b26f
+        with:
+          run_install: true
+      - run: pnpm build
       - if: github.event_name != 'pull_request'
         uses: actions/configure-pages@v4
       - if: github.event_name != 'pull_request'

.github/workflows/format.yaml

@@ -23,7 +23,9 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
-      - run: npm ci
+      - uses: pnpm/action-setup@58e6119fe4f3092a76a7771efb55e04d25b6b26f
+        with:
+          run_install: true
       - uses: FabricMCBot/markdownlint-cli2-action@b4c9feab76d8025d1e83c653fa3990936df0e6c8
         with:
           config: .markdownlint-cli2.yaml
@@ -42,7 +44,9 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
-      - run: npm ci
+      - uses: pnpm/action-setup@58e6119fe4f3092a76a7771efb55e04d25b6b26f
+        with:
+          run_install: true
       - run: npx prettier --write .
       - run: |
           readarray -d '' files < <(git ls-files --modified --others --exclude-standard -z)

.gitignore

@@ -10,8 +10,7 @@
 .DS_Store
 
 # Alternative Package Locks
-pnpm-lock.yaml
-pnpm-workspace.yaml
+package-lock.json
 yarn.lock
 
 # LanguageTool Dictionaries and False Positives

.prettierignore

@@ -1,4 +1,5 @@
 .vitepress/sidebars/versioned
+pnpm-lock.yaml
 reference/*.*
 reference/latest/src/main/generated
 translated

contributing.md

@@ -61,20 +61,20 @@ git clone https://github.com/your-username/fabric-docs.git
 
 #### Installing Dependencies {#install-dependencies}
 
-If you want to preview your changes locally, you will need to install [Node.js 18+](https://nodejs.org/en/).
+If you want to preview your changes locally, you will need to install [Node.js 18+](https://nodejs.org/en/) and [pnpm](https://pnpm.io/).
 
 After that, make sure to install all dependencies with:
 
 ```sh
-npm install
+pnpm install
 ```
 
 #### Running the Development Server {#run-the-development-server}
 
 This will allow you to preview your changes locally at `localhost:5173` and will automatically reload the page when you make changes.
 
 ```sh
-npm run dev
+pnpm dev
 ```
 
 Now you can open and browse the website from the browser by visiting `http://localhost:5173`.
@@ -84,15 +84,15 @@ Now you can open and browse the website from the browser by visiting `http://loc
 This will compile all Markdown files into static HTML files and place them in `.vitepress/dist`:
 
 ```sh
-npm run build
+pnpm build
 ```
 
 #### Previewing the Built Website {#previewing-the-built-website}
 
 This will start a local server on port `4173` serving the content found in `.vitepress/dist`:
 
 ```sh
-npm run preview
+pnpm preview
 ```
 
 #### Opening a Pull Request {#opening-a-pull-request}

develop/blocks/block-containers.md

@@ -13,17 +13,17 @@ In this tutorial we'll create a block that uses its container to duplicate any i
 
 This should be familiar to the reader if they've followed the [Creating Your First Block](../blocks/first-block) and [Block Entities](../blocks/block-entities) guides. We'll create a `DuplicatorBlock` that extends `BaseEntityBlock` and implements `EntityBlock`.
 
-@[code transcludeWith=:::block](@/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java#block
 
 Then, we need to create a `DuplicatorBlockEntity`, which needs to implement the `Container` interface. As most containers are generally expected to work the same way, you can copy and paste a helper called `ImplementedContainer` that does most of the work, leaving us with just a few methods to implement.
 
 ::: details Show `ImplementedContainer`
 
-@[code](@/reference/latest/src/main/java/com/example/docs/container/ImplementedContainer.java)
+<<< @/reference/latest/src/main/java/com/example/docs/container/ImplementedContainer.java
 
 :::
 
-@[code transcludeWith=:::be](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java#be
 
 The `items` list is where the container's contents are stored. For this block we have it set to a size of 1 slot for the input.
 
@@ -33,15 +33,15 @@ Don't forget to register the block and block entity in their respective classes!
 
 If we want the contents to persist between game reloads like a vanilla `BlockEntity`, we need to save it as NBT. Thankfully, Mojang provides a helper class called `ContainerHelper` with all the necessary logic.
 
-@[code transcludeWith=:::save](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java#save
 
 ## Interacting with the Container {#interacting-with-the-container}
 
 Technically, the container is already functional. However, to insert items, we currently need to use hoppers. Let's make it so that we can insert items by right-clicking the block.
 
 To do that, we need to override the `useItemOn` method in the `DuplicatorBlock`:
 
-@[code transcludeWith=:::useon](@/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java#useon
 
 Here, if the player is holding an item and there is an empty slot, we move the item from the player's hand to the block's container and return `InteractionResult.SUCCESS`.
 
@@ -55,7 +55,7 @@ Let's now make it so that the block duplicates the stack you threw in it, but on
 
 To do this, we'll add a `tick` function to the `DuplicatorBlockEntity`, and a field to store how much we've been waiting:
 
-@[code transcludeWith=:::tick](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java#tick
 
 The `DuplicatorBlock` should now have a `getTicker` method that returns a reference to `DuplicatorBlockEntity::tick`.
 
@@ -73,13 +73,13 @@ To create this behavior, we need to implement the `WorldlyContainer` interface i
 
 Let's modify the `DuplicatorBlockEntity` to only accept items from the top:
 
-@[code transcludeWith=:::accept](@/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/entity/custom/DuplicatorBlockEntity.java#accept
 
 The `getSlotsForFace` returns an array of the slot _indices_ that can be interacted with from the given side. In this case, we only have a single slot (`0`), so we return an array with just that index.
 
 Also, we should modify the `useItemOn` method of the `DuplicatorBlock` to actually respect the new behavior:
 
-@[code transcludeWith=:::place](@/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java)
+<<< @/reference/latest/src/main/java/com/example/docs/block/custom/DuplicatorBlock.java#place
 
 Now, if we try to insert items from the side instead of the top, it won't work!