27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
# Documentation Website Files and Assets
|
|
|
|
This directory contains extra files for modifying the look and functionality of
|
|
[mdbook](https://github.com/rust-lang/mdBook), the documentation software that's
|
|
used to generate Synapse's documentation website.
|
|
|
|
The configuration options in the `output.html` section of [book.toml](../../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.css` file.
|
|
|
|
* 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.js` and `version-picker.css` files, and is currently the only
|
|
requirement for the custom `theme/`.
|
|
|
|
More information can be found in mdbook's official documentation for
|
|
[injecting page JS/CSS](https://rust-lang.github.io/mdBook/format/config.html)
|
|
and
|
|
[customising the default themes](https://rust-lang.github.io/mdBook/format/theme/index.html).
|