mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-08 03:31:59 +02:00
1.4 KiB
1.4 KiB
Documentation
Documentation is written in mkdocs and there are a few extensions that allow richer authoring than markdown.
To iterate with documentation, therefore, it is recommended to run the mkdocs server and view your pages in a browser.
Prerequisites
NOTE to M1/M2 mac owners
If running on an arm64-based mac (M1 or M2, aka "Applie Silicon"), you may find this method quite slow. Until multiarch docker images can be built and made available, you may wish to build your own via:
git clone git@github.com:squidfunk/mkdocs-material.git
docker build -t docker.io/squidfunk/mkdocs-material .
Edit the docs
After installing mkdocs and extensions, build and run the documentation locally:
task docs:serve
The site will soon be available at http://0.0.0.0:8000 and update after changes.