diff --git a/docs/wiki/How To Contribute/example-page-code.md b/docs/wiki/How To Contribute/example-page-code.md deleted file mode 100644 index 4af5ebf..0000000 --- a/docs/wiki/How To Contribute/example-page-code.md +++ /dev/null @@ -1,66 +0,0 @@ -# Example base post code - -This is the exact code used for the [example page](./example-page.md). You can confirm this for yourself on the [Github](https://github.com/aleabodo/survival-pi-docs/blob/main/docs/wiki/How%20To%20Contribute/example-page.md) of course 🤗. - -```markdown -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Example base post - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - - - - Here can go a short description of the base. - - - | X | Y | Z | - | ----- | ----- | ----- | - | 42 | 69 | -42 | - - - The portals are directly linked with the nether hub. - - - - Albert Einstein - - Neil Armstrong - - Friedrich Nietzsche - - Steve - - - 04/07/2024 - - - -## Lore and Tales - -Some lore. Who doesn't like to write some lore 😃 *italic* **bold** __underline__. `Ever needed code too`? - -### A smaller headline - -#### An even smaller one - -- A list -- more list - -You can also add pictures anywhere in the lore. You may also add more sections if you see fit. It doesn't really matter. Your base, your post! 💪 - -## Build Process - -You can maybe describe how you build it. What you enjoyed most. You you just don't include this section add all or replace it with another. Your choice! 💯 - -Of course you can also complement your descriptions with pictures of your progression. - -## Additional Pictures - -You cann add more pictures here if you have good ones. People love pictures! 🤩 - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) -``` \ No newline at end of file diff --git a/docs/wiki/How To Contribute/example-page.md b/docs/wiki/How To Contribute/example-page.md index c9e29ac..528fbdf 100644 --- a/docs/wiki/How To Contribute/example-page.md +++ b/docs/wiki/How To Contribute/example-page.md @@ -1,64 +1,127 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Example base post - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) +# Example +This is an example markdown code and the resulting page that it outputs. You switch between both to get familiar with writing Markdown. - - Here can go a short description of the base. + + ```markdown + import Tabs from '@theme/Tabs'; + import TabItem from '@theme/TabItem'; + + # Example base post + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + + + Here can go a short description of the base. + + + | X | Y | Z | + | ----- | ----- | ----- | + | 42 | 69 | -42 | + + + The portals are directly linked with the nether hub. + + + - Albert Einstein + - Neil Armstrong + - Friedrich Nietzsche + - Steve + + + 04/07/2024 + + + + ## Lore and Tales + + Some lore. Who doesn't like to write some lore 😃 *italic* **bold** __underline__. `Ever needed code too`? + + ### A smaller headline + + #### An even smaller one + + - A list + - more list + + You can also add pictures anywhere in the lore. You may also add more sections if you see fit. It doesn't really matter. Your base, your post! 💪 + + ## Build Process + + Maybe you can describe how you build it. What you enjoyed most. Or you just don't include this section at all or replace it with another. Your choice! 💯 Of course you can also complement your descriptions with pictures of your progression if you want to. + + ## Additional Pictures + + You can add more pictures here if you have good ones. People love pictures! 🤩 + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + ``` - - | X | Y | Z | - | ----- | ----- | ----- | - | 42 | 69 | -42 | + + # Example base post + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + + + Here can go a short description of the base. + + + | X | Y | Z | + | ----- | ----- | ----- | + | 42 | 69 | -42 | + + + The portals are directly linked with the nether hub. + + + - Albert Einstein + - Neil Armstrong + - Friedrich Nietzsche + - Steve + + + 04/07/2024 + + + + ## Lore and Tales + + Some lore. Who doesn't like to write some lore 😃 *italic* **bold** ~line through~. `Ever needed code too`? + + ### A smaller headline + + #### An even smaller one + + - A list + - more list + + You can also add pictures anywhere in the lore. You may also add more sections if you see fit. It doesn't really matter. Your base, your post! 💪 + + ## Build Process + + Maybe you can describe how you build it. What you enjoyed most. Or you just don't include this section at all or replace it with another. Your choice! 💯 Of course you can also complement your descriptions with pictures of your progression if you want to. + + ## Additional Pictures + + You can add more pictures here if you have good ones. People love pictures! 🤩 + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) + + ![Some picture description](/img/season1/2024-07-03_00.03.39.png) - - The portals are directly linked with the nether hub. - - - - Albert Einstein - - Neil Armstrong - - Friedrich Nietzsche - - Steve - - - 04/07/2024 - - - -## Lore and Tales - -Some lore. Who doesn't like to write some lore 😃 *italic* **bold** ~line through~. `Ever needed code too`? - -:::info[Here is an info thing] -Put some extra info here if you need -::: - -### A smaller headline - -#### An even smaller one - -- A list -- more list - -You can also add pictures anywhere in the lore. You may also add more sections if you see fit. It doesn't really matter. Your base, your post! 💪 - -## Build Process - -You can maybe describe how you build it. What you enjoyed most. You you just don't include this section add all or replace it with another. Your choice! 💯 - -Of course you can also complement your descriptions with pictures of your progression. - -## Additional Pictures - -You cann add more pictures here if you have good ones. People love pictures! 🤩 - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) - -![Some picture description](/img/season1/2024-07-03_00.03.39.png) \ No newline at end of file + \ No newline at end of file diff --git a/docs/wiki/How To Contribute/tutorial.md b/docs/wiki/How To Contribute/tutorial.md index 09a2d59..dd10038 100644 --- a/docs/wiki/How To Contribute/tutorial.md +++ b/docs/wiki/How To Contribute/tutorial.md @@ -18,6 +18,8 @@ In this tutorial, I will guide you on how to edit, change, and add information t Don't be intimidated; contributing is quite straightforward! Rune222 even figured it out before this tutorial was written 🤙. +If you have questions, feel free to ask! + Here's the table of contents so you can navigate to the right section: @@ -60,7 +62,7 @@ These are some of the most important terms you should know when working with Git ![Fork this repository](/img/wiki/fork-this-repository.png) 1. **Edit the Page** \ - Now you can edit the website's code. Most pages, including the Wiki and Season pages, use Markdown, a simple format you might know from note-taking apps. To learn more, check out [this markdown cheatsheet](pathname://https://www.markdownguide.org/cheat-sheet/). To get started quickly, I recommend getting familiar with the existing text and checking out the [example page of a base](./example-page.md) and the [corresponding code](example-page-code.md). + Now you can edit the website's code. Most pages, including the Wiki and Season pages, use Markdown, a simple format you might know from note-taking apps. To learn more, check out [this markdown cheatsheet](pathname://https://www.markdownguide.org/cheat-sheet/). To get started quickly, I recommend getting familiar with the existing text and checking out the [example page of a base](./example-page.md) and the corresponding code. :::note[Some footnotes on editing:] - You can format pages however you see fit, not limited to specific templates.