Skip to content

Commit

Permalink
Document: How to build the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikDeSmedt authored and cdecker committed Mar 7, 2024
1 parent 1aad165 commit e91c156
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Greenlight docs

The docs are hosted on https://blockstream.github.io/greenlight/

## Contributing to the documentation

You must have a working installation of `python` and `poetry` to contribute to the docs.

To install dependencies make sure you are at the root of the repository

```
poetry install --with-only docs
```

To build the docs

```
cd docs; mkdocs build
```

To serve the docs locally
```
cd docs; mkdocs serve
```

0 comments on commit e91c156

Please sign in to comment.