diff --git a/www/README.md b/www/README.md index 7596bf5b8..c729ce959 100644 --- a/www/README.md +++ b/www/README.md @@ -7,7 +7,6 @@ To iterate with documentation, therefore, it is recommended to run the mkdocs se ## Prerequisites -- [Get Docker](https://docs.docker.com/get-docker/) - [Get Task](https://taskfile.dev/installation/) - [Get MkDocs](https://www.mkdocs.org/user-guide/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 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 -multiarch docker images can be built and made available, you may wish to build your own via: +If you have nix installed, you can: ```bash -git clone git@github.com:squidfunk/mkdocs-material.git -docker build -t docker.io/squidfunk/mkdocs-material . +nix develop .#docs ``` +To drop into a shell with all the needed dependencies. + ## Edit the docs 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 ``` -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.