Skip to content

Commit

Permalink
Change "Editing the Wiki" to "Editing the Docs" and update it for mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
guilherme-gm committed Apr 11, 2024
1 parent 5462d43 commit 619bd0e
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 12 deletions.
6 changes: 6 additions & 0 deletions README.md
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/)
38 changes: 38 additions & 0 deletions docs/contributing/editing-the-docs.md
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/)
10 changes: 0 additions & 10 deletions docs/contributing/editing-the-wiki.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ License version 1.2, this means that the wiki and any works put on it can be edi
distributed, provided all history and copylefts remain intact.

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

<center>

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

</center>

0 comments on commit 619bd0e

Please sign in to comment.