Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Docs

on:
push:
branches: [main]

permissions:
contents: read
pages: write
id-token: write

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@v5
- uses: actions/checkout@v5
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- uses: actions/upload-pages-artifact@v4
with:
path: site
- uses: actions/deploy-pages@v4
id: deployment
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ venv.bak/
# Rope project settings
.ropeproject

# mkdocs documentation
# zensical documentation
/site

# mypy
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,13 @@ $ uv run ruff format
$ uv run ruff check
```

The documenation site uses [Zensical](https://zensical.org/docs/).

```console
$ uv run zensical serve
$ uv run zensical build
```

---

License - [MIT](https://github.com/mcbeet/beet/blob/main/LICENSE)
Binary file added docs/images/beet_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
icon: lucide/house
---

# 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 follow the development of the project, discuss ideas, get help, and hang out with cool people interested in map-making and programming on our discord! You can also ask questions about Beet and get general help about Minecraft map-making on the Minecraft Commands discord server.

- **Beet** - The Minecraft pack development kit
[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)

- **Minecraft Commands** - General discussions about commands and map-making
[![Discord](https://img.shields.io/discord/154777837382008833?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/QAFXFtZ)

[Get started](./quick-start/get-started.md){ .md-button }

## Introduction

Minecraft [resource packs](https://minecraft.wiki/w/Resource_pack) and [data packs](https://minecraft.wiki/w/Data_pack) work well as _distribution_ formats but can be pretty limiting as _authoring_ formats. You can quickly end up having to manage hundreds of files, some of which might be buried within the bundled output of various generators.

The Beet project is a development kit that tries to unify data pack and resource pack tooling into a single pipeline. The community is always coming up with pre-processors, frameworks, and generators of all kinds to make the developer experience more ergonomic. With Beet you can seamlessly integrate all these tools in your project.

### Screencasts

- Quick start [https://youtu.be/JGrJTOhG3pY](https://youtu.be/JGrJTOhG3pY)
- Command-line [https://youtu.be/fQ9up0ELPNE](https://youtu.be/fQ9up0ELPNE)
- Library overview [https://youtu.be/LDvV4_l-PSc](https://youtu.be/LDvV4_l-PSc)
- Plugins basics [https://youtu.be/XTzKmvHqd1g](https://youtu.be/XTzKmvHqd1g)
- Pipeline configuration [https://youtu.be/QsnQncGxAAs](https://youtu.be/QsnQncGxAAs)
Loading