{"id":13821200,"url":"https://github.com/matrix-org/matrix-spec","last_synced_at":"2026-01-25T06:45:10.220Z","repository":{"id":37082716,"uuid":"464973089","full_name":"matrix-org/matrix-spec","owner":"matrix-org","description":"The Matrix protocol specification","archived":false,"fork":false,"pushed_at":"2025-02-25T21:00:33.000Z","size":14985,"stargazers_count":216,"open_issues_count":1084,"forks_count":108,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-02-25T21:32:21.809Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrix-org.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/README.md","contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"matrixdotorg","liberapay":"matrixdotorg"}},"created_at":"2022-03-01T16:33:46.000Z","updated_at":"2025-02-25T21:00:37.000Z","dependencies_parsed_at":"2023-09-26T22:25:20.992Z","dependency_job_id":"f281f212-d69b-4163-8b7e-9f0d907e74ef","html_url":"https://github.com/matrix-org/matrix-spec","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Fmatrix-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrix-org","download_url":"https://codeload.github.com/matrix-org/matrix-spec/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241654970,"owners_count":19997965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-04T08:01:17.371Z","updated_at":"2026-01-25T06:45:10.215Z","avatar_url":"https://github.com/matrix-org.png","language":"HTML","funding_links":["https://patreon.com/matrixdotorg","https://liberapay.com/matrixdotorg"],"categories":["HTML"],"sub_categories":[],"readme":"# Matrix Specification\n\nThis 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.\n\nDevelopers looking to use Matrix should join [#matrix-dev:matrix.org](https://matrix.to/#/#matrix-dev:matrix.org)\non Matrix for help.\n\nSpec authors and proposal writers are welcome to join [#matrix-spec:matrix.org](https://matrix.to/#/#matrix-spec:matrix.org).\nWe welcome contributions! See [CONTRIBUTING.rst](./CONTRIBUTING.rst) for details.\n\n## Structure\n\nThe Matrix spec is compiled with [Hugo](https://gohugo.io/) (a static site generator) with the following structure:\n\n* `/assets`: assets that need postprocessing using [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/).\n  For example, Sass files would go here.\n\n* `/content`: files that will become pages in the site go here. Typically these are Markdown files with some YAML front\n  matter indicating, [among other things](https://gohugo.io/content-management/front-matter/), what layout should be\n  applied to this page. The organization of files under `/content` determines the organization of pages in the built\n  site.\n\n* `/data`: this can contain TOML, YAML, or JSON files. Files kept here are directly available to template code as\n  [data objects](https://gohugo.io/templates/data-templates/), so templates don't need to load them from a file and\n  parse them. This is also where our OpenAPI definitions and schemas are.\n\n* `/layouts`: this contains [Hugo templates](https://gohugo.io/templates/). Some templates define the overall layout of\n  a page: for example, whether it has header, footer, sidebar, and so on.\n    * `/layouts/partials`: these templates can be called from other templates, so they can be used to factor out\n      template code that's used in more than one template. An obvious example here is something like a sidebar, where\n      several different page layouts might all include the sidebar. But also, partial templates can return values: this\n      means they can be used like functions, that can be called by multiple templates to do some common processing.\n    * `/layouts/shortcodes`: these templates can be called directly from files in `/content`.\n\n* `/static`: static files which don't need preprocessing. JS or CSS files could live here.\n\n* `/themes`: you can use just Hugo or use it with a theme. Themes primarily provide additional templates, which are\n  supplied in a `/themes/$theme_name/layouts` directory. You can use a theme but customise it by providing your own\n  versions of any of the theme layouts in the base `/layouts` directory. That is, if a theme provides\n  `/themes/$theme_name/layouts/sidebar.html` and you provide `/layouts/sidebar.html`, then your version of the\n  template will be used.\n\nIt also has the following top-level file:\n\n* `config.toml`: site-wide configuration settings. Some of these are built-in and you can add your own. Config settings\n  defined here are available in templates. All these directories above are configurable via `config.toml` settings.\n\nAdditionally, the following directories may be of interest:\n\n* `/attic`: Here contains historical sections of specification and legacy drafts for the specification.\n* `/changelogs`: Various bits of changelog for the specification areas.\n* `/data-definitions`: Bits of structured data consumable by Matrix implementations.\n* `/meta`: Documentation relating to the spec's processes that are otherwise untracked (release instructions, etc).\n* `/scripts`: Various scripts for generating the spec and validating its contents.\n* `/packages`: Various packages for shipping spec files like OpenAPI bindings and data definitions.\n\n## Authoring changes to the spec\n\nPlease read [CONTRIBUTING.rst](./CONTRIBUTING.rst) before authoring a change to the spec. Note that spec authoring takes\nplace after an MSC has been accepted, not as part of a proposal itself.\n\n1. Install the extended version (often the OS default) of Hugo:\n   \u003chttps://gohugo.io/getting-started/installing\u003e. Note that at least Hugo\n   v0.146.0 is required.\n\n   Alternatively, use the Docker image at\n   https://hub.docker.com/r/klakegg/hugo/. (The \"extended edition\" is required\n   to process the SCSS.)\n2. Run `npm i` to install the dependencies. Note that this will require NodeJS to be installed.\n3. Run `npm run get-proposals` to seed proposal data. This is merely for populating the content of the \"Spec Change Proposals\"\n   page and is not required.\n4. Run `hugo serve` (or `docker run --rm -it -v $(pwd):/src -p 1313:1313\n   klakegg/hugo:ext serve`) to run a local webserver which builds whenever a file\n   change is detected. If watching doesn't appear to be working for you, try\n   adding `--disableFastRender` to the commandline.\n5. Edit the specification 🙂\n\nWe use a highly customized [Docsy](https://www.docsy.dev/) theme for our generated site, which uses Bootstrap and Font\nAwesome. If you're looking at making design-related changes to the spec site, please coordinate with us in\n[#matrix-docs:matrix.org](https://matrix.to/#/#matrix-docs:matrix.org) before opening a PR.\n\n## Building the specification\n\nIf 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\nsteps for authoring changes to the specification and instead of `hugo serve` run `hugo -d \"spec\"` - this will generate the\nspec to `/spec`. If you'd like to serve the spec off a path instead of a domain root (eg: `/unstable`), add `--baseURL \"/unstable\"`\nto the `hugo -d \"spec\"` command.\n\nFor building the OpenAPI definitions, create a python3 virtualenv and activate it. Then run `pip install -r ./scripts/requirements.txt`\nand finally `python ./scripts/dump-openapi.py` to generate it to `./scripts/openapi/api-docs.json`. To make use of the generated file,\nthere are a number of options:\n\n* You can open `./scripts/openapi-preview.html` in your browser, and then open the file by clicking on `Local JSON File`.\n* You can run a local HTTP server by running `./scripts/openapi-http-server.py`, and then view the documentation by\n  opening `./scripts/openapi-preview.html` in your browser.\n\n## Issue tracking\n\nSpecification issues are tracked on github at \u003chttps://github.com/matrix-org/matrix-spec/issues\u003e.\n\nSee [meta/github-labels.rst](./meta/github-labels.rst) for information on what the labels mean.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Fmatrix-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrix-org%2Fmatrix-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Fmatrix-spec/lists"}