matrix.org/README.md
Kim Brose 963ee433ad
Simplify PR template, introduce MD linter (#3051)
* Convert checkboxes to questions

Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>

* document internal links

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* document blog taxonomies

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* update PR bot CI from https://github.com/HarHarLinks/pr-template-autoclose

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix heading depth (MD001 MD003)

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix code blocks

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix spaces in link text (MD039)

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix no newline at end of file (MD047)

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix bare URLs without angle backets (MD034)

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* remove redundant attribute

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* linter exception

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* lint links and headings with rumdl instead of checklist

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* convert signoff checklist to heading

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* configure linter to .rumdl.toml explicitly

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* bump rumdl action

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* Shorten comments in the template

Co-authored-by: Thibault Martin <thibaultamartin@users.noreply.github.com>
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>

* Remove rumdl default config example comments

Co-authored-by: Thibault Martin <thibaultamartin@users.noreply.github.com>
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>

* explain more about the pr-bot

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* pin rumdl action to v0

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* fix unlinked email address in coc

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

---------

Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
Co-authored-by: Thibault Martin <thibaultamartin@users.noreply.github.com>
2025-12-09 14:26:51 +01:00

1.7 KiB

Matrix.org Website

If you want to contribute to the website, make sure the problem you're trying to fix or the feature you want to implement has been discussed in our issue tracker and that we are interested in reviewing and merging such a contribution.

We are self-documenting our processes in CONTRIBUTING.md and how to write content for the website in CONTENT.md.

To discuss maintenance of this site, please come talk to us, the Website & Content Working Group, in #matrix.org-website:matrix.org.

Cloning the Repository

Due to historic growth and media the repository is quite large. Therefor we suggest the usage of --filter=blob:none when doing a fresh clone:

git clone --filter=blob:none git@github.com:matrix-org/matrix.org.git

This allows to only fetch the actually needed things from the git repository instead of all of the (at the time of writing) 1.18GiB of data. With this command at the time of writing this reduces the downloaded data to just 612MiB.

For more information on this please check out these 2 articles which also explain why --depth=1 is not ideal and which implications this has:

Building the website

Install the latest version of Zola, clone the repo, and from the root of the repo type

zola serve

Zola will build the website and start a web server, usually at http://127.0.0.1:1111