4c807ca305
The custom theme is still needed for the version picker. Technically we could add this HTML in the version-picker.js, but there's no guarantee that the HTML IDs etc. wouldn't change out from under us. We also no longer need the next/prev hiding plugin, as the original point of it was to prevent those UI elements from interfering with our custom TOC.
Documentation Website Files and Assets
This directory contains extra files for modifying the look and functionality of mdbook, the documentation software that's used to generate Synapse's documentation website.
The configuration options in the output.html section of book.toml
point to additional JS/CSS in this directory that are added on each page load. In
addition, the theme directory contains files that overwrite their counterparts in
each of the default themes included with mdbook.
Currently we use these files to make a few modifications:
-
We stylise the chapter titles in the left sidebar by indenting them slightly so that they are more visually distinguishable from the section headers (the bold titles). This is done through the
indent-section-headers.cssfile. -
We add a version picker pertaining to the different documentation versions shipped with each version of Synapse. This functionality was implemented through the
version-picker.jsandversion-picker.cssfiles, and is currently the only requirement for the customtheme/.
More information can be found in mdbook's official documentation for injecting page JS/CSS and customising the default themes.