mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
53ed81665b
* Support mTLS with client certificate when configured. * Fix the omitempty typo. * Add check for missing cert as well. * Added documentation for artifactory and upload, as well as how to run mkdocs locally * set pip version to just 3. * Added example to the full config. * Remove the Pipfile and update documentation to mention the task. * update language in doc about multiarch images. Co-authored-by: Sheridan C Rawlins <scr@ouryahoo.com>
22 lines
722 B
Markdown
22 lines
722 B
Markdown
# 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
|
|
|
|
- [Get Docker](https://docs.docker.com/get-docker/)
|
|
- [Get Task](https://taskfile.dev/installation/)
|
|
|
|
### 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:
|
|
|
|
```bash
|
|
git clone git@github.com:squidfunk/mkdocs-material.git
|
|
docker build -t docker.io/squidfunk/mkdocs-material .
|
|
```
|