diff options
Diffstat (limited to 'docs/website_files/README.md')
| -rw-r--r-- | docs/website_files/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/website_files/README.md b/docs/website_files/README.md new file mode 100644 index 0000000000..acf73350d6 --- /dev/null +++ b/docs/website_files/README.md @@ -0,0 +1,20 @@ +# 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 generate a floating Table of Contents page. +The code for which was partially taken from +[JorelAli/mdBook-pagetoc](https://github.com/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](https://rust-lang.github.io/mdBook/format/config.html) +and +[customising the default themes](https://rust-lang.github.io/mdBook/format/theme/index.html). \ No newline at end of file |