Skip to content

Files

This branch is 5 commits ahead of, 2673 commits behind matrix-org/synapse:develop.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
May 12, 2022
Apr 12, 2022
May 24, 2022
May 31, 2022
Mar 2, 2022
Oct 12, 2018
Jan 27, 2022
Apr 25, 2022
May 27, 2022
Apr 13, 2022
Jul 8, 2021
Nov 1, 2021
Nov 19, 2021
May 18, 2022
Nov 16, 2021
Apr 27, 2020
Sep 17, 2019
Jan 11, 2021
Jan 11, 2021
Jan 11, 2021
Apr 14, 2022
Nov 1, 2021
Nov 1, 2021
Dec 21, 2021
Jun 3, 2021
Jun 3, 2021
Mar 8, 2022
May 4, 2022
Sep 10, 2021
Feb 23, 2022
Nov 29, 2021
Nov 1, 2021
Jun 16, 2021
May 19, 2022
May 14, 2021
Nov 12, 2021
Mar 23, 2022
Aug 17, 2021
May 9, 2022
Apr 25, 2022
Jul 8, 2021
May 27, 2022
Apr 29, 2022
Jul 15, 2021
Jul 15, 2021
Jan 5, 2022
Apr 6, 2022
Nov 1, 2021
Feb 22, 2021
Mar 11, 2022
Apr 22, 2022
May 31, 2022
Nov 19, 2021
May 18, 2022
May 19, 2022

Synapse Documentation

The documentation is currently hosted here. Please update any links to point to the new website instead.

About

This directory currently holds a series of markdown files documenting how to install, use and develop Synapse. The documentation is readable directly from this repository, but it is recommended to instead browse through the website for easier discoverability.

Adding to the documentation

Most of the documentation currently exists as top-level files, as when organising them into a structured website, these files were kept in place so that existing links would not break. The rest of the documentation is stored in folders, such as setup, usage, and development etc. All new documentation files should be placed in structured folders. For example:

To create a new user-facing documentation page about a new Single Sign-On protocol named "MyCoolProtocol", one should create a new file with a relevant name, such as "my_cool_protocol.md". This file might fit into the documentation structure at:

  • Usage
    • Configuration
      • User Authentication
        • Single Sign-On
          • My Cool Protocol

Given that, one would place the new file under usage/configuration/user_authentication/single_sign_on/my_cool_protocol.md.

Note that the structure of the documentation (and thus the left sidebar on the website) is determined by the list in SUMMARY.md. The final thing to do when adding a new page is to add a new line linking to the new documentation file:

- [My Cool Protocol](usage/configuration/user_authentication/single_sign_on/my_cool_protocol.md)

Building the documentation

The documentation is built with mdbook, and the outline of the documentation is determined by the structure of SUMMARY.md.

First, get mdbook. Then, from the root of the repository, build the documentation with:

mdbook build

The rendered contents will be outputted to a new book/ directory at the root of the repository. Please note that index.html is not built by default, it is created by copying over the file welcome_and_overview.html to index.html during deployment. Thus, when running mdbook serve locally the book will initially show a 404 in place of the index due to the above. Do not be alarmed!

You can also have mdbook host the docs on a local webserver with hot-reload functionality via:

mdbook serve

The URL at which the docs can be viewed at will be logged.

Configuration and theming

The look and behaviour of the website is configured by the book.toml file at the root of the repository. See mdbook's documentation on configuration for available options.

The site can be themed and additionally extended with extra UI and features. See website_files/README.md for details.