Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
 into main
kad-michij committed Mar 18, 2024
2 parents 7b5d20d + 4e3d5b3 commit b4c70d9
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lock Unlock Docs

[![Publish docs via GitHub Pages](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/gh-pages.yml)
[![Publish [dev] docs via GitHub Pages](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/publish-dev-docs.yml/badge.svg)](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/publish-dev-docs.yml)
[![pages-build-deployment](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/pages/pages-build-deployment)

This repo contains the documentation of the [Lock-Unlock
@@ -29,6 +29,20 @@ Develop & serve on [localhost:8000](http://localhost:8000/):
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```

## Publish & Versioning

The documentation of this repo is published on [GitHub Pages](https://pages.github.com/). It is set
up to support multiple versions of the documentation seperately. It uses
[mike](https://github.com/jimporter/mike) to do so, following the documetation of mkdocs: [Seting up
versioning](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/). This means:

- the `main` branch is published under 'version' `dev`
- every branch starting with `v` is published under the branch name; e.g. branch `v0.90` is
published as such
- there is a workflow available to [set the default
version](https://github.com/kadaster-labs/lock-unlock-docs/actions/workflows/set-default.yml) to
show; this takes a manual input ( :warning: be sure to enter a matching name)

## License

Om hergebruik en doorontwikkeling maximaal mogelijk te maken, is dit project gelicenseerd onder

0 comments on commit b4c70d9

Please sign in to comment.