matrix.org public website
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Andrew Morgan 57d7b6482a
Fix typo CI for TWIM 20220812 (#1400)
1 day ago
.github Fix typo CI for TWIM 20220812 (#1400) 1 day ago
content Fix the newly found typos (#1242) 7 months ago
gatsby Publish TWIM 20220812 (#1399) 1 day ago
implementation-guides Fix the newly found typos (#1242) 7 months ago
jsfiddles 🚚 Move out of the jekyll tree 7 months ago
legacy-spec 👷 Replace jekyll with sass 7 months ago
rapidoc Make other API available in the playground (#1246) 6 months ago
scripts Make other API available in the playground (#1246) 6 months ago
unstyled_docs/spec Remove redundant `.htaccess` file (#1293) 5 months ago
.gitignore ⚰️ Remove any leftovers from jekyll 7 months ago
.gitmodules 💄 Switch from Swagger UI to RapiDoc (#1081) 11 months ago
README.md Move projects/ top-level files into relevant category subfolders 11 months ago

README.md

Matrix.org Website

To discuss maintenance of this site, please come talk to the team in #matrix.org-website:matrix.org.

How to build

  1. Make sure you have the prerequisites:
    • Node.js and npm
    • git clone https://github.com/matrix-org/matrix.org && cd matrix.org
  2. cd gatsby
  3. Run npm i to install dependencies
  4. npm run develop - It will take a while on your first build

Now you can visit the page you want to work on in the browser. For example: http://127.0.0.1:8000/docs/projects/try-matrix-now/

How to add your project to Try Matrix Now

  1. Prerequisites:
    • Text editor or web IDE (MDX support is nice to have but not necessary)
    • git clone https://github.com/matrix-org/matrix.org && cd matrix.org
  2. cd gatsby
  3. cp project-template.mdx content/projects/{bots|bridges|clients|iot|sdks|servers|other}/project-name.mdx
  4. Edit the file to include information about your project
  5. To include images in your posting, add them to gatsby/static/docs/projects/images/. Avoid linking to images on other websites.
  6. To check how the rendered result looks (strongly recommended), follow "How to build" steps.
  7. Once it looks good, submit a pull request!