mirror of
https://github.com/itzg/docker-minecraft-server.git
synced 2026-02-18 15:36:22 +00:00
17 lines
1.0 KiB
Markdown
17 lines
1.0 KiB
Markdown
# Site documentation
|
|
|
|
The documentation for this image/repository is written in markdown and built using [Zensical](https://zensical.org/) into a documentation website hosted at [Read the Docs](https://readthedocs.org/). [Here is general information about writing Zensical markdown](https://zensical.org/docs/authoring/markdown/).
|
|
|
|
!!! note
|
|
The README.md rarely needs to be modified and only serves as a brief introduction to the project.
|
|
|
|
The documentation source is maintained in the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs) folder and is organized into sections by directory and files. Look through the existing content to determine if an existing file should be updated or a new file/directory added.
|
|
|
|
It will be very helpful to view the rendered documentation as you're editing. To do that run the following from the top-level directory:
|
|
|
|
```shell
|
|
docker compose -f compose-docs.yml -p zensical up
|
|
```
|
|
|
|
You can access the live documentation rendering at <http://localhost:8000>.
|