mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-24 04:16:27 +02:00

History

<!--

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

Fixes wording in the docs page about Git being in a dirty state.

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

The goal is to improve the end-user reading of the instructions.

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

...

2022-11-10 22:30:18 -03:00

docs

docs: fix wording (#3542 )

2022-11-10 22:30:18 -03:00

htmltest.yml

docs: fix htmltest

2022-10-12 00:04:19 -03:00

mkdocs.yml

docs: fix redirects

2022-11-08 00:18:14 -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 .