mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
de72cab5d9
<!-- Hi, thanks for contributing! Please make sure you read our CONTRIBUTING guide. Also, add tests and the respective documentation changes as well. --> <!-- If applied, this commit will... --> If applied, this commit will allow users to create BlueSky posts (skeets) about their Goreleaser-built projects <!-- Why is this change being made? --> Because I wanted to post to BlueSky when projects I work on relating to BlueSky are built! <!-- # Provide links to any relevant tickets, URLs or other resources --> Example post made during unit testing (requires an account to see): https://bsky.app/profile/jaygles.bsky.social/post/3kpv573c2pc2k --------- Co-authored-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.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.