made example page into one

This commit is contained in:
Alexander Bell 2024-07-04 05:06:30 +02:00
parent 0d03bef066
commit 465c0f6bfa
3 changed files with 123 additions and 124 deletions

View File

@ -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)
<Tabs>
<TabItem value="about" label="Description">
Here can go a short description of the base.
</TabItem>
<TabItem value="coords" label="Coords" default>
| X | Y | Z |
| ----- | ----- | ----- |
| 42 | 69 | -42 |
</TabItem>
<TabItem value="ncooords" label="Nether Directions">
The portals are directly linked with the nether hub.
</TabItem>
<TabItem value="builders" label="Builders">
- Albert Einstein
- Neil Armstrong
- Friedrich Nietzsche
- Steve
</TabItem>
<TabItem value="date" label="Date Finished">
04/07/2024
</TabItem>
</Tabs>
## 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)
```

View File

@ -1,6 +1,15 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Example
This is an example markdown code and the resulting page that it outputs. You switch between both to get familiar with writing Markdown.
<Tabs>
<TabItem value="code" label="Code">
```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)
@ -30,11 +39,7 @@ import TabItem from '@theme/TabItem';
## 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
:::
Some lore. Who doesn't like to write some lore 😃 *italic* **bold** __underline__. `Ever needed code too`?
### A smaller headline
@ -47,13 +52,11 @@ You can also add pictures anywhere in the lore. You may also add more sections i
## 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.
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 cann add more pictures here if you have good ones. People love 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)
@ -62,3 +65,63 @@ 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)
```
</TabItem>
<TabItem value="output" label="Output" default>
# Example base post
![Some picture description](/img/season1/2024-07-03_00.03.39.png)
<Tabs>
<TabItem value="about" label="Description">
Here can go a short description of the base.
</TabItem>
<TabItem value="coords" label="Coords" default>
| X | Y | Z |
| ----- | ----- | ----- |
| 42 | 69 | -42 |
</TabItem>
<TabItem value="ncooords" label="Nether Directions">
The portals are directly linked with the nether hub.
</TabItem>
<TabItem value="builders" label="Builders">
- Albert Einstein
- Neil Armstrong
- Friedrich Nietzsche
- Steve
</TabItem>
<TabItem value="date" label="Date Finished">
04/07/2024
</TabItem>
</Tabs>
## 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)
</TabItem>
</Tabs>

View File

@ -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:
<TOCInline toc={toc} />
@ -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.