diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..c67ce97b2dc --- /dev/null +++ b/docs/README.md @@ -0,0 +1,18 @@ +To build the docs locally, you need to have docker installed. The docs are built using a custom [docker](https://www.docker.com/) +image and [mkdocs](http://www.mkdocs.org/). + +Build the `grafana/docs-base:latest` image: + +``` +$ git clone https://github.com/grafana/docs-base +$ cd docs-base +$ make docs-build +``` + +To build the docs: +``` +$ cd docs +$ make docs +``` + +Open [localhost:8100](http://localhost:8180) to view the docs.