mirror of
https://github.com/grafana/grafana.git
synced 2024-11-25 18:30:41 -06:00
Add docs for building the docs locally
This commit is contained in:
parent
17063df3cc
commit
3693f36e59
18
docs/README.md
Normal file
18
docs/README.md
Normal 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.
|
Loading…
Reference in New Issue
Block a user