mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-04 03:11:55 +02:00
c08d7cd9ad
## Description Corrected some spelling errors in the `www/docs/install.md` and `www/docs/blog/posts/2024-09-12-v2.3.md` . Signed-off-by: Ruihua Wen <spiffyeight77@gmail.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| htmltest.yml | ||
| mkdocs.yml | ||
| README.md | ||
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
With nix
If you have nix installed, you can:
nix develop .#docs
To drop into a shell with all the needed dependencies.
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://localhost:8000 and auto-update after changes.