From 162de994c2532d384529b8b7c2eb1ba4018b38ee Mon Sep 17 00:00:00 2001 From: Jeremy Salwen Date: Wed, 1 Feb 2023 14:24:33 -0500 Subject: [PATCH] Add comment to README about need for copying css and js files. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e2ab4e0..06cc0dc 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,9 @@ require «doc-gen4» from "../doc-gen4" The root of the built docs will be `build/docs/index.html`. However, due to the "Same Origin Policy", the generated website will be partially broken if you just open the generated html files in your browser. You need to serve them from a proper http server for it to work. An easy way to do that is to run -`python3 -m http.server` from the `build/docs` directory. \ No newline at end of file +`python3 -m http.server` from the `build/docs` directory. + +Note that if you modify the `.js` or `.css` files in doc-gen4, they won't necessarily be copied over when +you rebuild the documentation. You can manually copy the changes to the `build/docs` directory to make +sure the changes appear, or just do a full recompilation (`lake clean` and `lake build` inside the `doc-gen4` +directory.) \ No newline at end of file