Skip to content

Commit 619bd0e

Browse files
committed
Change "Editing the Wiki" to "Editing the Docs" and update it for mkdocs
1 parent 5462d43 commit 619bd0e

File tree

4 files changed

+46
-12
lines changed

4 files changed

+46
-12
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Hercules documentation
2+
3+
This repository contains Hercules documentation.
4+
5+
- **Live docs:** [https://docs.herc.ws/](https://docs.herc.ws/)
6+
- **How to contribute:** [https://docs.herc.ws/contributing/editing-the-docs/](https://docs.herc.ws/contributing/editing-the-docs/)

docs/contributing/editing-the-docs.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Editing the Docs
2+
3+
The Hercules docs could always use help. It is an ever changing repository of useful information related to Hercules, such as configuration, connecting, setting up, Compiling and scripting. However, please follow the below points when trying to edit.
4+
5+
1. Do not create pages or guides for custom content. Base client specific content is OK, as this is the main point behind Hercules. However, leave patchers, custom patches or plugins, setup of custom items or mobs, or control panels out.
6+
2. Be sure you write in proper and complete English.
7+
3. For code examples, be sure you follow [Hercules' Coding Style](./coding-style.md).
8+
9+
10+
## Contributting
11+
Hercules docs is completely based on the repository files, in order to contribute to it, simply
12+
submit a [Pull request](./creating-pull-requests.md) to the [Hercules-docs repository](https://github.com/HerculesWS/hercules-docs).
13+
14+
15+
## Setup
16+
Hercules docs uses mkdocs-material.
17+
18+
You will need to have Python3 installed and install `mkdocs-material` package.
19+
20+
You can install it with `pip install mkdocs-material` or `pip3 install mkdocs-material`.
21+
22+
For more information about installing mkdocs-material, and other alternatives,
23+
see [Mkdocs Material's getting started](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
24+
25+
After installing mkdocs-material, in order to run hercules docs in your machine, you will have to:
26+
27+
1. Clone hercules-docs repository to your local machine
28+
2. Open a terminal in the folder and run `mkdocs serve`
29+
3. The documentation should be running at http://localhost:8000
30+
31+
32+
## Editing
33+
The documentation is entirely written in Markdown, with some extensions from mkdocs and mkdocs-material.
34+
35+
If you are new to markdown or want to know about the extended syntax from mkdocs, please check the following links:
36+
37+
- [Markdown Syntax](https://www.markdownguide.org/basic-syntax/)
38+
- [Mkdocs Material Reference](https://squidfunk.github.io/mkdocs-material/reference/)

docs/contributing/editing-the-wiki.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ License version 1.2, this means that the wiki and any works put on it can be edi
1313
distributed, provided all history and copylefts remain intact.
1414

1515
Please do not create pages for custom content, such as custom projects not relating to Hercules in any way. A full list
16-
of content that should not be on the wiki is listed at [Editing the wiki](contributing/editing-the-wiki.md).
16+
of content that should not be on the wiki is listed at [Editing the Docs](contributing/editing-the-docs.md).
1717

1818
<center>
1919

2020
![](assets/GitRepo.png) [Git Repository](https://github.com/HerculesWS/Hercules)
21-
| ![](assets/WikiEdit.png) [Editing the wiki]()
21+
| ![](assets/WikiEdit.png) [Editing the Docs](contributing/editing-the-docs.md)
2222
| ![](assets/Support.png) [Assistance & Support](https://herc.ws/board/)
2323

2424
</center>

0 commit comments

Comments
 (0)