Skip to content

Commit 6ad256b

Browse files
ItsNeil17ItsNeil17
authored
Merge pull request #483 from Dobya11/main
Adding documentation about the wiki.
2 parents 8bceec5 + 0e8f72b commit 6ad256b

File tree

21 files changed

+10631
-97
lines changed

21 files changed

+10631
-97
lines changed

‎bun.lock‎

Lines changed: 91 additions & 53 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎content/docs/en/contributing/translate.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ icon: Globe
6161
```
6262
---
6363

64-
{/* crowdin-ignore-start */}
64+
<div translate="no">
6565
{/*
6666
For translators who will edit this page:
6767
6868
- You are required to translate the Guidelines as they change.
6969
- General guidelines should be translated but not edited.
7070
- Learn how to use Markdown from [Writing Guides](.contributing/writing_guides)
7171
*/}
72-
{/* crowdin-ignore-end */}
72+
</div>

‎content/docs/en/contributing/writing-guides.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,20 +113,20 @@ Available types are: `info`, `warning`, `error`, and `success`.
113113
## Difficulty levels
114114

115115
These are types of callouts, they are optional, they show how complex your page can be.
116-
There are 3 main types of complexity.
116+
There are 3 main levels of complexity.
117117

118118
<Callout type="lvl_beginner">
119119
Use `lvl_beginner`. This page contains information for those who are starting out with modding.
120120
</Callout>
121121
<Callout type="lvl_intermediate">
122-
Use `lvl_intermediate` This page contains information for those who want to deepen their knowledge.
122+
Use `lvl_intermediate`. This page contains information for those who want to deepen their knowledge.
123123
</Callout>
124124
<Callout type="lvl_advanced">
125-
Use `lvl_advanced`This page contains information for those who already know how to make quality mods, and contains something additional.
125+
Use `lvl_advanced`. This page contains information for those who already know how to make quality mods, and contains something additional.
126126
</Callout>
127127

128128
Their usage is the same as in callout, but we would advise not to change the title. Inside,
129-
you write why your page is classified as this type and what the user should know.
129+
you write why your page is classified as this level and what the user should know.
130130

131131
## Conclusion
132132

‎content/docs/en/meta.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"---Community---",
1313
"publishing",
1414
"projects",
15-
"contributing"
15+
"contributing",
16+
"wiki"
1617
]
1718
}

‎content/docs/en/wiki/1-create-account.mdx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: 1 - Account Creation
3+
description: How to create and set up your account.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## 1. Creating an account
10+
11+
Go to the [site](https://wiki.hytalemodding.dev/) and click **Register**.
12+
13+
<Callout type="info">
14+
Already have an account? Just click **Login** instead.
15+
</Callout>
16+
17+
After registering, you'll be taken to the main page. You don't need it right now, but it will come up in the next step.
18+
19+
## 2. Setting up your account
20+
21+
To access your settings, click your profile picture in the top-right corner and select **Settings** —
22+
or follow [this link](https://wiki.hytalemodding.dev/settings/profile) directly.
23+
24+
On the left you'll find four sections:
25+
26+
- [**Profile**](https://wiki.hytalemodding.dev/settings/profile): Basic account information.
27+
- [**Password**](https://wiki.hytalemodding.dev/settings/password): Change your password.
28+
- [**Two-Factor Auth**](https://wiki.hytalemodding.dev/settings/two-factor): Add an extra layer of security to your account.
29+
- [**Appearance**](https://wiki.hytalemodding.dev/settings/appearance): Customize the look of the site.
30+
31+
To update your profile picture, click **Upload Photo** and choose an image. That's all for the basic setup.

‎content/docs/en/wiki/2-create-mod.mdx‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: 2 - Creating a Wiki for Your Mod
3+
description: How to create and configure a wiki for your mod.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## 1. Creating a mod
10+
11+
Start by going to the [dashboard](https://wiki.hytalemodding.dev/dashboard).
12+
If you haven't created any mods yet, you'll see a **"No mods yet"** message with a create button below it.
13+
If you already have mods, they'll be listed there — click **New mod** to add another.
14+
15+
On the creation page, you'll see the following fields:
16+
17+
- **Mod name** _(Required)_: The name of your mod as it will appear on pages.
18+
- **Description** _(Optional)_: A short description of what your mod does.
19+
- **Mod Icon** _(Optional)_: An icon to represent your mod.
20+
- **Visibility** _(Required, default: "Private")_: Controls who can see your mod.
21+
22+
### About visibility
23+
24+
- **Private**: Only you and your collaborators can see this mod.
25+
- **Unlisted**: Accessible to anyone with the link, but won't appear in public listings.
26+
- **Public**: Your mod will be listed [here](https://wiki.hytalemodding.dev/mods).
27+
28+
Since you're just getting started, **Private** or **Unlisted** is recommended.
29+
30+
Congratulations — you've created your first mod wiki!
31+
32+
## 2. Collaborators
33+
34+
If you're working with a team and want to give members editing access, you can add them as collaborators.
35+
36+
On your mod's main page, look for the collaborators panel in the bottom-left — initially it will only show you.
37+
Click **Manage** to open the collaborator settings.
38+
39+
There you'll see the owner, a list of collaborators, and a reference to the available permission levels:
40+
41+
- **Owner**: Full control over everything. This role cannot be changed.
42+
- **Admin**: Can create, edit, and delete pages. Can also manage collaborators and invite new members.
43+
- **Editor**: Can create, edit, and publish pages. Cannot manage collaborators or mod settings.
44+
- **Viewer**: Can view private mod content, but cannot edit or create pages.
45+
46+
To add someone, click **Invite Collaborators**, enter their username, and select a role.
47+
They'll receive an email invitation — once they accept, they'll appear in your collaborators list.
48+
49+
<Callout type="info">
50+
If you plan on creating pages on GitHub, check out the [guide there](./6-github).
51+
</Callout>

‎content/docs/en/wiki/3-creating-pages.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: 3 - Creating Pages
3+
description: How to create and manage your mod pages.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## Creating a page
10+
11+
To add a page to your mod, open your mod's management page and click **New Page**.
12+
This will take you to the page editor — the screen you'll spend most of your time on.
13+
14+
### Page settings
15+
16+
At the top you'll find the page configuration fields:
17+
18+
- **Page title** _(Required)_: The name of your page as it will appear in the sidebar and heading.
19+
- **Page type** _(Optional, default: "Page")_: Choose between **Page** (regular content) or **Category** (an empty grouping page with no content of its own).
20+
- **Parent page** _(Optional)_: Nest this page under another — useful for building a hierarchy.
21+
- **Index page** _(Optional)_: Mark this page as the mod's landing page, shown when someone first opens your mod.
22+
- **Published** _(Required)_: Whether the page is visible to readers. Unpublished pages are saved as drafts — visible only to you and your collaborators, regardless of the mod's visibility setting.
23+
24+
### Editor
25+
26+
Below the settings you'll find two panels:
27+
28+
- **Content Editor**: Where you write your page content in Markdown.
29+
- **Live Preview**: A real-time preview of how your page will look when published.
30+
31+
### Saving your page
32+
33+
At the bottom of the page you have three options:
34+
35+
- **Cancel**: Discard and go back without creating anything.
36+
- **Save as draft**: Save the page without publishing it.
37+
- **Publish**: Save and publish the page immediately.
38+
39+
---
40+
41+
You're ready to create pages! To learn how to format content and make your pages look great,
42+
see [Styling your pages](./styling/index.mdx).

‎content/docs/en/wiki/4-editing-pages.mdx‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: 4 - Editing and Organizing Pages
3+
description: How to edit pages and organize them.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## 1. Editing a page
10+
11+
To edit a page, click the pencil icon in your mod's page list, or click **Edit** while viewing a page.
12+
13+
Editing works the same as creating a page, with one difference — the buttons at the bottom:
14+
15+
- **Cancel**: Discard your changes and go back.
16+
- **Delete Page**: Permanently delete this page.
17+
- **Save as draft**: Save the page without publishing it.
18+
- **Publish**: Save and publish the page.
19+
20+
## 2. Organizing your pages
21+
22+
### Nesting pages
23+
24+
You can nest pages under a parent to create a hierarchy — set the **Parent page** field when creating or editing a page.
25+
26+
### Reordering pages
27+
28+
To change the order pages appear in the sidebar, go to your mod's management page,
29+
click **View all Pages**, then **Reorder Pages**.
30+
Drag pages into the desired order and click **Exit** when done.
31+
32+
---
33+
34+
You now know how to edit pages and control how they're arranged.

‎content/docs/en/wiki/5-styling/5-1-markdown.mdx‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: 5.1 - Markdown
3+
description: Markdown formatting reference for wiki pages.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## Text formatting
10+
```md
11+
**Bold text**
12+
*Italic text*
13+
~~Strikethrough~~
14+
**_Bold and italic_**
15+
```
16+
17+
## Headings
18+
```md
19+
# Heading 1
20+
## Heading 2
21+
### Heading 3
22+
#### Heading 4
23+
```
24+
25+
## Lists
26+
27+
### Unordered
28+
```md
29+
- Item
30+
- Item
31+
- Nested item
32+
- Nested item
33+
- Item
34+
```
35+
36+
### Ordered
37+
```md
38+
1. First
39+
2. Second
40+
1. Nested
41+
2. Nested
42+
3. Third
43+
```
44+
45+
### Task list
46+
```md
47+
- [x] Done
48+
- [ ] Not done
49+
```
50+
51+
## Links
52+
```md
53+
[Link text](https://example.com)
54+
[Link with title](https://example.com "Hover title")
55+
```
56+
57+
## Images
58+
59+
The site may contain images from external resources.
60+
61+
```md
62+
![Alt text](https://example.com/image.png)
63+
![Alt text](https://example.com/image.png "Image title")
64+
```
65+
66+
## Code
67+
68+
### Inline
69+
```md
70+
Use `code` inside text.
71+
```
72+
73+
### Block
74+
```md
75+
```js
76+
const hello = "world";
77+
console.log(hello);
78+
```
79+
```
80+
81+
Supported language hints: `js`, `ts`, `css`, `html`, `json`, `md`, `bash`, and others.
82+
83+
## Blockquotes
84+
```md
85+
> This is a blockquote.
86+
> It can span multiple lines.
87+
>
88+
> And multiple paragraphs.
89+
```
90+
91+
## Alerts
92+
93+
Alerts are styled blockquotes for highlighting important information.
94+
```md
95+
> [!NOTE]
96+
> Useful information the reader should know.
97+
98+
> [!TIP]
99+
> Helpful advice for doing things better.
100+
101+
> [!IMPORTANT]
102+
> Key information the reader must be aware of.
103+
104+
> [!WARNING]
105+
> Potential issues the reader should watch out for.
106+
107+
> [!CAUTION]
108+
> Actions that may cause problems or data loss.
109+
```
110+
111+
## Tables
112+
```md
113+
| Column A | Column B | Column C |
114+
| -------- | -------- | -------- |
115+
| Cell | Cell | Cell |
116+
| Cell | Cell | Cell |
117+
```
118+
119+
Alignment:
120+
```md
121+
| Left | Center | Right |
122+
| :------- | :------: | -------: |
123+
| Cell | Cell | Cell |
124+
```
125+
126+
## Horizontal rule
127+
```md
128+
---
129+
```
130+
131+
## Footnotes
132+
```md
133+
Some text with a footnote.[^1]
134+
135+
[^1]: This is the footnote content.
136+
```
137+
138+
## Escaping characters
139+
```md
140+
\*Not italic\*
141+
\# Not a heading
142+
```
143+
144+
<Callout type="info">
145+
Imported components are only available when editing via GitHub sync.
146+
The built-in editor supports custom components registered on the platform.
147+
</Callout>

‎content/docs/en/wiki/5-styling/5-2-images.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: 5.2 - Images
3+
description: How to upload and use images in your wiki pages.
4+
authors:
5+
- name: "Dobya"
6+
url: "https://discordapp.com/users/1242082598281281629"
7+
---
8+
9+
## Uploading images
10+
11+
To upload images, go to your mod's management page and click **Upload Files**.
12+
Once uploaded, copy the file link and use it in your page:
13+
```md
14+
![Alt text](https://wiki.hytalemodding.dev/storage/mods/{mod-id}/files/{file-id}.png)
15+
```
16+
17+
You can also add a title that appears on hover:
18+
```md
19+
![Alt text](https://wiki.hytalemodding.dev/storage/mods/{mod-id}/files/{file-id}.png "Image title")
20+
```

0 commit comments

Comments
 (0)