docs: update homepage

mcbeet · Mar 24, 2021 · 3a25a4c · 3a25a4c
1 parent 2a96811
commit 3a25a4c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 21 deletions.
diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,22 @@
+# Beet documentation
+
+Welcome! This is the place where you'll eventually find everything there is to know about the `beet` project. The documentation is currently a work-in-progress, you're welcome to help write guides and contribute example use-cases. In the meantime, don't be afraid to check out the code!
+
+---
+
+You can ask questions about `beet` and get general help about Minecraft map-making on the Minecraft Commands discord server. [![Discord](https://img.shields.io/discord/154777837382008833?color=7289DA&label=discord&logo=discord&logoColor=fff)](http://discord.gg/QAFXFtZ)
+
+```{toctree}
+:hidden:
+
+library
+toolchain
+```
+
+```{toctree}
+:caption: Project links
+:hidden:
+
+GitHub Repository <https://github.com/mcbeet/beet>
+PyPI Package <https://pypi.org/project/beet>
+```
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -88,6 +88,7 @@ preset = "furo"
 [tool.mudkip.override]
 html_title = "Beet documentation"
 html_logo = "assets/logo.png"
+html_favicon = "assets/favicon.png"
 
 [tool.mudkip.override.html_theme_options]
 sidebar_hide_name = true