README.md
1# H3 Documentation Website
2
3This is the source for the [H3 documentation website](https://h3geo.org/).
4
5The source of the pages in the documentation is in the [docs](../docs) directory.
6
7## Building Locally
8
9Building the documentation requires Node.js. To build and view the H3 documentation,
10run the following from `./website`:
11
12```
13yarn
14yarn run build
15```
16
17You will then be able to open `public/index.html` in your browser. Note that images
18will not render because they expect a `/h3/` path prefix.
19
20## Updating the H3 Website
21
22Make sure your `gh-pages` branch has its remote set to the upstream repo, then
23
24```
25make publish-website
26```
27