mirror of
https://github.com/maxkratz/matrix.org.git
synced 2024-09-07 23:03:02 +00:00
1.2 KiB
1.2 KiB
Matrix.org Website
To discuss maintenance of this site, please come talk to the team in #matrix.org-website:matrix.org.
How to build
- Make sure you have the prerequisites:
- npm
- Gatsby:
npm i -g gatsby-cli
git clone https://github.com/matrix-org/matrix.org && cd matrix.org
cd gatsby
- Run
npm i
to install dependencies gatsby develop
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
- 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
cd gatsby
cp project-template.mdx content/projects/{bots|bridges|clients|sdks|other}/project-name.mdx
- Edit the file to include information about your project
- To include images in your posting, add them to
gatsby/static/docs/projects/images/
. Avoid linking to images on other websites. - To check how the rendered result looks (strongly recommended), follow "How to build" steps.
- Once it looks good, submit a pull request!