From 66ffa9d5f943872f9363963cb2cdd4ad301e30e2 Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Sun, 3 Dec 2023 21:52:25 +0000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7fa0ffe..9d6edee9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ```