Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Dec 3, 2023
1 parent 839d709 commit 66ffa9d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,14 @@ To update autogenerated Node documentation:
auxiliary/scripts/auto-generator.py --library --readme
```

To generate and serve the docs:
For generating HTML documentation, install `mkdocs` and associated plugins:

```
pip3 install mkdocs mkdocs-material mkdocs-include-markdown-plugin mkdocs-git-revision-date-localized-plugin
```

To serve the HTML documentation locally, on `http://localhost:8000`:
```
mkdocs serve
```

Expand Down

0 comments on commit 66ffa9d

Please sign in to comment.