1
0
Files
synapse/docs/website_files
Andrew Morgan 22aa21071c Remove chapter navigation buttons on desktop
As they interfere with the table of contents, and aren't really needed
on desktop UI.

Buttons are still kept for mobile.
2021-05-27 15:25:52 +01:00
..
2021-05-27 15:25:52 +01:00
2021-05-27 15:25:52 +01:00

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 generate a floating Table of Contents page. The code for which was partially taken from JorelAli/mdBook-pagetoc before being modified such that it scrolls with the content of the page.

More information can be found in mdbook's official documentation for injecting page JS/CSS and customising the default themes.