go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +02:00
Code Issues Releases Activity
0c6d209946
goreleaser/www
History
Mark Phelps 0c6d209946
docs: fix typo in pro docs (#3586) 
achives -> archives

<!--

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... -->

...

<!-- Why is this change being made? -->

...

<!-- # Provide links to any relevant tickets, URLs or other resources
-->

...
2022-11-22 22:37:01 -03:00
..
docs docs: fix typo in pro docs (#3586) 2022-11-22 22:37:01 -03:00
htmltest.yml docs: fix htmltest 2022-10-12 00:04:19 -03:00
mkdocs.yml docs: mastodon 2022-11-20 13:20:26 -03:00
README.md feat: mTLS with client certificate (#3302) 2022-08-12 09:44:54 -03:00

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

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 .