Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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!