Skip to content

Commit

Permalink
Add links to the Hex discord, other support locations, and the generi…
Browse files Browse the repository at this point in the history
…c mod template
  • Loading branch information
object-Object committed May 2, 2024
1 parent 24d5267 commit fecc399
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ A [Jinja](https://jinja.palletsprojects.com/en/3.1.x/)-based documentation gener

This is the library that powers [Hex Casting](https://github.com/gamma-delta/HexMod)'s web book.

Check out the docs at [https://hexdoc.hexxy.media](https://hexdoc.hexxy.media)!

## IMPORTANT: Version incompatibilities

There are issues related to installing hexdoc with the following dependency versions:
Expand All @@ -23,7 +25,14 @@ hexdoc is known to work with Python 3.11.

## Plugins

See [hexdoc-hexcasting-template](https://github.com/hexdoc-dev/hexdoc-hexcasting-template) for instructions to set up a hexdoc plugin for a pre-existing Hex Casting addon.
hexdoc has a few Copier templates that you can use to set up a hexdoc plugin for your mod:

* [hexdoc-mod-template](https://github.com/hexdoc-dev/hexdoc-mod-template): generic template
* [hexdoc-hexcasting-template](https://github.com/hexdoc-dev/hexdoc-hexcasting-template): Hex Casting addons (also compatible with [HexDummy](https://github.com/FallingColors/hexdummy)!)

## Support

hexdoc does not currently have a dedicated support server. If you have any questions, please feel free to join the [Hex Casting Discord server](https://discord.gg/4xxHGYteWk) and ask in the [#hexdoc](https://discord.com/channels/936370934292549712/1180655324684894309) channel, or open an [issue](https://github.com/hexdoc-dev/hexdoc/issues)/[discussion](https://github.com/hexdoc-dev/hexdoc/discussions) on GitHub.

## Contributing

Expand Down
4 changes: 4 additions & 0 deletions web/docusaurus/docs/01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ hexdoc is a [Jinja](https://jinja.palletsprojects.com/en/3.1.x/)-based documenta

This is the library that powers [Hex Casting](https://github.com/gamma-delta/HexMod)'s [web book](https://hexcasting.hexxy.media).

## Support

hexdoc does not currently have a dedicated support server. If you have any questions, please feel free to join the [Hex Casting Discord server](https://discord.gg/4xxHGYteWk) and ask in the [#hexdoc](https://discord.com/channels/936370934292549712/1180655324684894309) channel, or open an [issue](https://github.com/hexdoc-dev/hexdoc/issues)/[discussion](https://github.com/hexdoc-dev/hexdoc/discussions) on GitHub.

## Hex Casting addons

In addition to the [default admonitions](https://docusaurus.io/docs/markdown-features/admonitions) provided by Docusaurus, this documentation includes some notes providing context/tips that are specifically meant for developers of Hex Casting addons. These notes are styled like this:
Expand Down

0 comments on commit fecc399

Please sign in to comment.