aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/resources/html/README.md
diff options
context:
space:
mode:
authorXia Li-yao <Lysxia@users.noreply.github.com>2019-02-27 21:53:27 -0500
committerAlec Theriault <alec.theriault@gmail.com>2019-02-27 21:53:27 -0500
commit59843f9e3d222901421a92fff793a1e031f38f65 (patch)
treedc80ea5a4194a6f38598b19bfea42a78ccf1d27f /haddock-api/resources/html/README.md
parent5d45da4898f7e8e7a1637b4cd473c393063034a0 (diff)
Menu item controlling which instances are expanded/collapsed (#1007)
Adds a menu item (like "Quick Jump") for options related to displaying instances. This provides functionality for: * expanding/collapsing all instances on the currently opened page * controlling whether instances are expanded/collapsed by default * controlling whether the state of instances should be "remembered" This new functionality is implemented in Typescript in `details-helper`. The built-in-themes style switcher also got a revamp so that all three of QuickJump, the style switcher, and instance preferences now have the same style and implementation structure. See also: https://mail.haskell.org/pipermail/haskell-cafe/2019-January/130495.html Fixes #698. Co-authored-by: Lysxia <lysxia@gmail.com> Co-authored-by: Nathan Collins <conathan@galois.com>
Diffstat (limited to 'haddock-api/resources/html/README.md')
-rw-r--r--haddock-api/resources/html/README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/haddock-api/resources/html/README.md b/haddock-api/resources/html/README.md
index 0552f6fd..d555989d 100644
--- a/haddock-api/resources/html/README.md
+++ b/haddock-api/resources/html/README.md
@@ -13,4 +13,10 @@ After each change to the TypeScript sources, compile and copy the generated file
```
gulp && cp *.min.js path-to/generated-haddock-docs && cp *.js.map path-to/generated-haddock-docs
-``` \ No newline at end of file
+```
+
+If you are editing the CSS, you'll also need to copy the edited CSS files. E.g. if you are editing the global/default quick-jump.css and the Linuwial theme's CSS, then
+
+```
+cp quick-jump.css Linuwial.std-theme/linuwial.css path-to/generated-haddock-docs
+```