Home Explore Help
Sign In
RISCI_ATOM
/
synapse
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Files Issues 3 Wiki
Branch: anoa/as_edu_fixes
Branches Tags
synapse
/
docs
/
website_files
Azrenbeth 54aa7047eb Removed page summaries from the top of installation and contributing doc pages (#10711) 3 years ago
..
theme fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
README.md fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
indent-section-headers.css fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
remove-nav-buttons.css fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
table-of-contents.css 54aa7047eb Removed page summaries from the top of installation and contributing doc pages (#10711) 3 years ago
table-of-contents.js fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago

README.md

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 panel. The code for which was partially taken from JorelAli/mdBook-pagetoc before being modified such that it scrolls with the content of the page. This is handled by the table-of-contents.js/css files. The table of contents panel only appears on pages that have more than one header, as well as only appearing on desktop-sized monitors.

We remove the navigation arrows which typically appear on the left and right side of the screen on desktop as they interfere with the table of contents. This is handled by the remove-nav-buttons.css file.

Finally, we also 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.

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