The Matrix protocol specification
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Richard van der Hoff 976ebdca2f
Update HTML templates to link to object definitions (#1724)
1 day ago
.github Fix npm release script (#1713) 1 month ago
assets Update docsy to v0.8.0 (#1699) 2 days ago
attic Add a hyphen between third and party when used as an adjective (#1447) 12 months ago
changelogs Update HTML templates to link to object definitions (#1724) 1 day ago
content Use a POST request in Federation request signing example (#1721) 2 days ago
data Add local user erasure requests (#1730) 2 days ago
data-definitions Update data-definitions 6 months ago
informal Update idp-brands.md (#1140) 2 years ago
layouts Update HTML templates to link to object definitions (#1724) 1 day ago
meta Update typos action and fix typos (#1661) 5 months ago
packages/npm Create @matrix-org/spec npm package containing sas-emoji.json (#1620) 7 months ago
scripts Add more CI checks for OpenAPI definitions and JSON Schemas (#1656) 5 months ago
static Fix the sidebar in recent versions of Hugo (#1551) 8 months ago
.gitignore Replace all mentions of Swagger by OpenAPI (#1633) 5 months ago
.htmltest.yaml Add htmltest github action 1 year ago
CONTRIBUTING.rst Wording tweak in CONTRIBUTING.rst (#1697) 2 months ago
LICENSE Add a license to the spec 8 years ago
README.md Update docsy to v0.8.0 (#1699) 2 days ago
config.toml Update docsy to v0.8.0 (#1699) 2 days ago
go.mod Update docsy to v0.8.0 (#1699) 2 days ago
go.sum Update docsy to v0.8.0 (#1699) 2 days ago
openapi_extensions.md Replace all mentions of Swagger by OpenAPI (#1633) 5 months ago
package-lock.json Update docsy to v0.8.0 (#1699) 2 days ago
package.json Update docsy to v0.8.0 (#1699) 2 days ago
redocly.yaml Use Redocly CLI to validate OpenAPI definitions (#1558) 9 months ago

README.md

Matrix Specification

This repository contains the Matrix Specification. The current release version is rendered at https://spec.matrix.org, while the latest available build of the main branch is at https://spec.matrix.org/unstable.

Developers looking to use Matrix should join #matrix-dev:matrix.org on Matrix for help.

Spec authors and proposal writers are welcome to join #matrix-spec:matrix.org. We welcome contributions! See CONTRIBUTING.rst for details.

Structure

The Matrix spec is compiled with Hugo (a static site generator) with the following structure:

  • /assets: assets that need postprocessing using Hugo Pipes. For example, Sass files would go here.

  • /content: files that will become pages in the site go here. Typically these are Markdown files with some YAML front matter indicating, among other things, what layout should be applied to this page. The organization of files under /content determines the organization of pages in the built site.

  • /data: this can contain TOML, YAML, or JSON files. Files kept here are directly available to template code as data objects, so templates don't need to load them from a file and parse them. This is also where our OpenAPI definitions and schemas are.

  • /layouts: this contains Hugo templates. Some templates define the overall layout of a page: for example, whether it has header, footer, sidebar, and so on.

    • /layouts/partials: these templates can be called from other templates, so they can be used to factor out template code that's used in more than one template. An obvious example here is something like a sidebar, where several different page layouts might all include the sidebar. But also, partial templates can return values: this means they can be used like functions, that can be called by multiple templates to do some common processing.
    • /layouts/shortcodes: these templates can be called directly from files in /content.
  • /static: static files which don't need preprocessing. JS or CSS files could live here.

  • /themes: you can use just Hugo or use it with a theme. Themes primarily provide additional templates, which are supplied in a /themes/$theme_name/layouts directory. You can use a theme but customise it by providing your own versions of any of the theme layouts in the base /layouts directory. That is, if a theme provides /themes/$theme_name/layouts/sidebar.html and you provide /layouts/sidebar.html, then your version of the template will be used.

It also has the following top-level file:

  • config.toml: site-wide configuration settings. Some of these are built-in and you can add your own. Config settings defined here are available in templates. All these directories above are configurable via config.toml settings.

Additionally, the following directories may be of interest:

  • /attic: Here contains historical sections of specification and legacy drafts for the specification.
  • /changelogs: Various bits of changelog for the specification areas.
  • /data-definitions: Bits of structured data consumable by Matrix implementations.
  • /meta: Documentation relating to the spec's processes that are otherwise untracked (release instructions, etc).
  • /scripts: Various scripts for generating the spec and validating its contents.
  • /packages: Various packages for shipping spec files like OpenAPI bindings and data definitions.

Authoring changes to the spec

Please read CONTRIBUTING.rst before authoring a change to the spec. Note that spec authoring takes place after an MSC has been accepted, not as part of a proposal itself.

  1. Install the extended version (often the OS default) of Hugo: https://gohugo.io/getting-started/installing. Note that at least Hugo v0.110.0 is required.

    Alternatively, use the Docker image at https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required to process the SCSS.)

  2. Run npm i to install the dependencies. Note that this will require NodeJS to be installed.

  3. Run npm run get-proposals to seed proposal data. This is merely for populating the content of the "Spec Change Proposals" page and is not required.

  4. Run hugo serve (or docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:ext serve) to run a local webserver which builds whenever a file change is detected. If watching doesn't appear to be working for you, try adding --disableFastRender to the commandline.

  5. Edit the specification 🙂

We use a highly customized Docsy theme for our generated site, which uses Bootstrap and Font Awesome. If you're looking at making design-related changes to the spec site, please coordinate with us in #matrix-docs:matrix.org before opening a PR.

Building the specification

If for some reason you're not a CI/CD system and want to render a static version of the spec for yourself, follow the above steps for authoring changes to the specification and instead of hugo serve run hugo -d "spec" - this will generate the spec to /spec. If you'd like to serve the spec off a path instead of a domain root (eg: /unstable), add --baseURL "/unstable" to the hugo -d "spec" command.

For building the OpenAPI definitions, create a python3 virtualenv and activate it. Then run pip install -r ./scripts/requirements.txt and finally python ./scripts/dump-openapi.py to generate it to ./scripts/openapi/api-docs.json. To make use of the generated file, there are a number of options:

  • You can open ./scripts/openapi-preview.html in your browser, and then open the file by clicking on Local JSON File.
  • You can run a local HTTP server by running ./scripts/openapi-http-server.py, and then view the documentation by opening ./scripts/openapi-preview.html in your browser.

Issue tracking

Specification issues are tracked on github at https://github.com/matrix-org/matrix-spec/issues.

See meta/github-labels.rst for information on what the labels mean.