go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-26 04:22:05 +02:00
Code Issues Releases Activity

docs: update docs/readme.md

Browse Source
This commit is contained in:
Carlos Alexandro Becker 2024-01-15 10:40:44 -03:00
parent deaa221a9b
commit e74c849ad4
No known key found for this signature in database
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
www/README.md
View File

@ -7,7 +7,6 @@ To iterate with documentation, therefore, it is recommended to run the mkdocs se
## Prerequisites ## Prerequisites
- [Get Docker](https://docs.docker.com/get-docker/)
- [Get Task](https://taskfile.dev/installation/) - [Get Task](https://taskfile.dev/installation/)
- [Get MkDocs](https://www.mkdocs.org/user-guide/installation/) - [Get MkDocs](https://www.mkdocs.org/user-guide/installation/)
- [Get MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/#installation) - [Get MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
@ -16,16 +15,16 @@ To iterate with documentation, therefore, it is recommended to run the mkdocs se
- [Get MkDocs Include Markdown](https://github.com/mondeja/mkdocs-include-markdown-plugin#installation) - [Get MkDocs Include Markdown](https://github.com/mondeja/mkdocs-include-markdown-plugin#installation)
- [Get MkDocs RSS](https://github.com/guts/mkdocs-rss-plugin#installation) - [Get MkDocs RSS](https://github.com/guts/mkdocs-rss-plugin#installation)
### NOTE to M1/M2 mac owners ### With nix
If running on an arm64-based mac (M1 or M2, aka "Apple Silicon"), you may find this method quite slow. Until If you have nix installed, you can:
multiarch docker images can be built and made available, you may wish to build your own via:
```bash ```bash
git clone git@github.com:squidfunk/mkdocs-material.git nix develop .#docs
docker build -t docker.io/squidfunk/mkdocs-material .
``` ```
To drop into a shell with all the needed dependencies.
## Edit the docs ## Edit the docs
After installing mkdocs and extensions, build and run the documentation locally: After installing mkdocs and extensions, build and run the documentation locally:
@ -34,4 +33,5 @@ After installing mkdocs and extensions, build and run the documentation locally:
task docs:serve task docs:serve
``` ```
The site will soon be available at http://0.0.0.0:8000 and update after changes. The site will soon be available at http://localhost:8000 and
auto-update after changes.