From 7f50082972912195221b2154b2467787ae52b1b1 Mon Sep 17 00:00:00 2001 From: basebuilder Date: Sat, 3 Feb 2024 16:00:40 +0100 Subject: [PATCH] expand info in README --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 42c3f0c..d831906 100644 --- a/README.md +++ b/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) -> 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 ``` -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/)