Inicio Explorar Axuda
Iniciar sesión
RISCI_ATOM
/
synapse
réplica de https://github.com/matrix-org/synapse.git
1
0
Fork 0
Ficheiros Incidencias 3 Wiki
Rama: master
Ramas Etiquetas
synapse
/
docs
/
website_files
Action Bot ee37039031 Version picker added for v1.98 docs hai 11 meses
..
theme ee37039031 Version picker added for v1.98 docs hai 11 meses
README.md ee37039031 Version picker added for v1.98 docs hai 11 meses
indent-section-headers.css fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) %!s(int64=3) %!d(string=hai) anos
remove-nav-buttons.css fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) %!s(int64=3) %!d(string=hai) anos
table-of-contents.css 54aa7047eb Removed page summaries from the top of installation and contributing doc pages (#10711) %!s(int64=3) %!d(string=hai) anos
table-of-contents.js 0922462fc7 docs: Don't render the table of contents on the print page (#12340) %!s(int64=2) %!d(string=hai) anos
version-picker.css ee37039031 Version picker added for v1.98 docs hai 11 meses
version-picker.js ee37039031 Version picker added for v1.98 docs hai 11 meses
version.js ee37039031 Version picker added for v1.98 docs hai 11 meses

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.

In addition to these modifications, we have added a version picker to the documentation. Users can switch between documentations for different versions of Synapse. This functionality was implemented through the version-picker.js and version-picker.css files.

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