Add docs for building the docs locally

This commit is contained in:
Jason Wilder 2015-03-12 13:19:59 -06:00
parent 17063df3cc
commit 3693f36e59

18
docs/README.md Normal file
View File

@ -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.