github.com/goreleaser/goreleaser@v1.25.1/www/README.md (about)

     1  # Documentation
     2  
     3  Documentation is written in mkdocs and there are a few extensions that allow richer
     4  authoring than markdown.
     5  
     6  To iterate with documentation, therefore, it is recommended to run the mkdocs server and view your pages in a browser.
     7  
     8  ## Prerequisites
     9  
    10  - [Get Task](https://taskfile.dev/installation/)
    11  - [Get MkDocs](https://www.mkdocs.org/user-guide/installation/)
    12    - [Get MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
    13    - [Get MkDocs Redirect](https://github.com/mkdocs/mkdocs-redirects#installing)
    14    - [Get MkDocs Minify](https://github.com/byrnereese/mkdocs-minify-plugin#setup)
    15    - [Get MkDocs Include Markdown](https://github.com/mondeja/mkdocs-include-markdown-plugin#installation)
    16    - [Get MkDocs RSS](https://github.com/guts/mkdocs-rss-plugin#installation)
    17  
    18  ### With nix
    19  
    20  If you have nix installed, you can:
    21  
    22  ```bash
    23  nix develop .#docs
    24  ```
    25  
    26  To drop into a shell with all the needed dependencies.
    27  
    28  ## Edit the docs
    29  
    30  After installing mkdocs and extensions, build and run the documentation locally:
    31  
    32  ```sh
    33  task docs:serve
    34  ```
    35  
    36  The site will soon be available at http://localhost:8000 and
    37  auto-update after changes.