11# Contributing Guide
22
3- Contributing to the Datapack Wiki is very easy. We use MDSveX to integrate
3+ Contributing to the Datapack Wiki is designed to be very easy. We use MDSveX to integrate
44markdown pages with the SvelteKit backend, so to add or edit pages you only need
55to know how to write Markdown, and very limited HTML knowledge.
66
@@ -20,8 +20,8 @@ few requirements:
2020
2121- [ Node] ( https://nodejs.org/en )
2222- A package manager (` npm ` , the default with node.js, is more than enough)
23- - [ Bun (optional)] ( https://bun.sh ) - we use this to generate our search indexes,
24- it can also be used to run the project
23+ - [ Bun (optional)] ( https://bun.sh ) - we use this to generate our search indexes faster and for package management ,
24+ but it can also be used to run the project
2525
2626### Installing
2727
@@ -38,11 +38,11 @@ the dev URL.
3838
3939` $ npm run dev `
4040
41- ### Checking for errors (optional)
41+ ### Checking for errors
4242
4343It's recommended before you make your pull request that you run the ` build ` and
44- ` check ` commands with your package manager . These will check for common issues
45- you may run into.
44+ ` check ` commands with your preferred script runner (e.g. ` npm run ... ` ) . These will check for common issues
45+ you may run into. In addition, check that there are no spelling or grammatical mistakes you can see
4646
4747## Adding a page
4848
@@ -54,15 +54,17 @@ you may run into.
5454
5555 ``` yml
5656 ---
57- title : Page title
57+ title : <page title>
5858 description : " Here is a short description!"
59+ version : <minecraft version> (optional, only needed if you have a version component)
5960 ---
6061 ```
6162
62- 3 . Import the reusable components that you want to use in your page. Put the
63- following after the metadata:
63+ 3 . Import the reusable components that you want to use in your page.
64+ We recommend the version component for guide and wiki pages if they are subject to change.
65+ Put the following after the metadata:
6466
65- ``` svelte
67+ ``` html
6668 <script lang =" ts" >
6769 import { Version } from " $lib/reusables" ;
6870 </script >
@@ -76,24 +78,7 @@ you may run into.
7678 This command runs any ` .mcfunction ` file when called. You can also pass in a NBT
7779 compound or NBT source path.
7880
79- ::: info
80-
81- I am a very important piece of information. Please dont ignore me. I'm
82- only smol.
83-
84- :::
85-
86- ::: warning
87-
88- The stuff in this box is probably very important.
89-
90- :::
91-
92- ::: tip
93-
94- You can do this really cool thing. It'll make your life a lot better!
95-
96- :::
81+ ...
9782 ```
9883
9984> [ !TIP]
0 commit comments