1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www
Michal Jan Matczuk aecc9ea982
docs: homebrew link to resource-not-accessible-by-integration (#4003)
This adds information on token configuration in hopes that users who
read it will avoid the error.

Co-authored-by: Michał Matczuk <mmatczuk@gmail.com>
2023-05-11 09:47:00 -03:00
..
docs docs: homebrew link to resource-not-accessible-by-integration (#4003) 2023-05-11 09:47:00 -03:00
htmltest.yml build: fix htmltest config 2023-01-16 22:14:23 -03:00
mkdocs.yml docs: multi platform docker images 2023-05-04 02:28:12 +00:00
README.md feat: mTLS with client certificate (#3302) 2022-08-12 09:44:54 -03:00

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 .