forked from coop-cloud/docs.coopcloud.tech
expand info in README
This commit is contained in:
parent
31a502cf6f
commit
7f50082972
16
README.md
16
README.md
|
@ -1,13 +1,21 @@
|
||||||
# docs.coopcloud.tech
|
# docs.coopcloud.tech :open_book:
|
||||||
|
|
||||||
[![Build Status](https://build.coopcloud.tech/api/badges/coop-cloud/docs.coopcloud.tech/status.svg)](https://build.coopcloud.tech/coop-cloud/docs.coopcloud.tech)
|
[![Build Status](https://build.coopcloud.tech/api/badges/coop-cloud/docs.coopcloud.tech/status.svg)](https://build.coopcloud.tech/coop-cloud/docs.coopcloud.tech)
|
||||||
|
|
||||||
> https://docs.coopcloud.tech
|
View: [docs.coopcloud.tech](https://docs.coopcloud.tech)
|
||||||
|
|
||||||
## hacking
|
|
||||||
|
## Developing / Hacking
|
||||||
|
|
||||||
|
Co-op Cloud's docs are created with the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) framework.
|
||||||
|
|
||||||
|
To install dependencies and serve local build of site, simply run:
|
||||||
|
|
||||||
```
|
```
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
Theme docs are [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/) and [there](https://squidfunk.github.io/mkdocs-material/reference/).
|
Useful docs for theming and content reference:
|
||||||
|
|
||||||
|
- [Changing the colors](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/)
|
||||||
|
- [Reference](https://squidfunk.github.io/mkdocs-material/reference/)
|
||||||
|
|
Loading…
Reference in New Issue