1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-13 13:48:40 +02:00
Jamie Tanna 8eea2ddf15
docs: pre-fill scopes for new Personal Access Token (#4010)
To make it easier for someone to create a new GitHub Personal Access
Token.
2023-05-15 09:26:08 -03:00
..
2023-01-16 22:14:23 -03:00
2023-05-04 02:28:12 +00: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 .