-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change "Editing the Wiki" to "Editing the Docs" and update it for mkdocs
- Loading branch information
1 parent
5462d43
commit 619bd0e
Showing
4 changed files
with
46 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Hercules documentation | ||
|
||
This repository contains Hercules documentation. | ||
|
||
- **Live docs:** [https://docs.herc.ws/](https://docs.herc.ws/) | ||
- **How to contribute:** [https://docs.herc.ws/contributing/editing-the-docs/](https://docs.herc.ws/contributing/editing-the-docs/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Editing the Docs | ||
|
||
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. | ||
|
||
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. | ||
2. Be sure you write in proper and complete English. | ||
3. For code examples, be sure you follow [Hercules' Coding Style](./coding-style.md). | ||
|
||
|
||
## Contributting | ||
Hercules docs is completely based on the repository files, in order to contribute to it, simply | ||
submit a [Pull request](./creating-pull-requests.md) to the [Hercules-docs repository](https://github.com/HerculesWS/hercules-docs). | ||
|
||
|
||
## Setup | ||
Hercules docs uses mkdocs-material. | ||
|
||
You will need to have Python3 installed and install `mkdocs-material` package. | ||
|
||
You can install it with `pip install mkdocs-material` or `pip3 install mkdocs-material`. | ||
|
||
For more information about installing mkdocs-material, and other alternatives, | ||
see [Mkdocs Material's getting started](https://squidfunk.github.io/mkdocs-material/getting-started/#installation) | ||
|
||
After installing mkdocs-material, in order to run hercules docs in your machine, you will have to: | ||
|
||
1. Clone hercules-docs repository to your local machine | ||
2. Open a terminal in the folder and run `mkdocs serve` | ||
3. The documentation should be running at http://localhost:8000 | ||
|
||
|
||
## Editing | ||
The documentation is entirely written in Markdown, with some extensions from mkdocs and mkdocs-material. | ||
|
||
If you are new to markdown or want to know about the extended syntax from mkdocs, please check the following links: | ||
|
||
- [Markdown Syntax](https://www.markdownguide.org/basic-syntax/) | ||
- [Mkdocs Material Reference](https://squidfunk.github.io/mkdocs-material/reference/) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters