jyc / indoor-wiki Goto Github PK

One goal I had was for everything to be usable offline. But because MathJax is so big, we load it from a remote CDN. This won't work if you're offline, and I wonder if there are even security concerns.

It'd be cool if it were possible to automatically generate a table of contents.

This would probably involve adding traversal features to ocaml-cmark.
Alternatively we could generate ToCs using JavaScript, though I don't always like this experience.

Customizable sidebars would be cool.
Perhaps both a left and right customizable sidebar.
The left sidebar could be the global sidebar and the right sidebar could be the document sidebar.
The global sidebar might be loaded from _bar.md and the right sidebar might be loaded from filename_bar.md.

Not sure how best to do this.

One thing that might help would be adding an opam file to our fork of ocaml-scgi. Then when Lwt updated, users wouldn't get weird bugs and have to manually rebuild everything that depends on it.

It is kind of annoying to force users to have to copy our static/ directory in order to get something going.
Should we embed the default CSS, JS, etc.?

On the other hand, our HTML is not very special.

At the least, it would be cool if there was a script that facilitated updating (something as simple as keeping track of the Git rev their copy is based on, and updating based on a diff).