maxkratz/matrix.org
1
0
Fork 0
mirror of https://github.com/maxkratz/matrix.org.git synced 2024-05-21 04:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
matrix.org public website
4978 commits 106 branches 0 tags 604 MiB
HTML 69.3%
JavaScript 27.2%
CSS 2.6%
Roff 0.7%
Go to file
Ben Parsons fa8c820b26 update Dept of Ping
2020-11-13 20:11:42 +00:00
.buildkite Add basic index.html 2020-10-16 16:50:04 +01:00
content Deploy a .well-known/matrix/server file. 2020-04-14 16:06:49 +01:00
gatsby update Dept of Ping 2020-11-13 20:11:42 +00:00
implementation-guides Add basic index.html 2020-10-16 16:50:04 +01:00
jekyll Tweak Jekyll styles for readability 2020-10-07 15:07:43 -07:00
pre-generated Replace all occurrences of matrix-js-bot-sdk with 2020-09-07 21:05:23 +02:00
scripts Replace all occurrences of matrix-js-bot-sdk with 2020-09-07 21:05:23 +02:00
swagger-ui@64dc3060b3 Revert "Revert "Update swagger-ui to 2.2.10"" 2017-04-19 16:44:54 +01:00
unstyled_docs Update default room version 2020-10-05 15:44:13 -06:00
.gitignore Add a implementation guide 2020-06-09 20:29:13 +01:00
.gitmodules Pull the spec from jenkins 2017-08-03 22:52:53 +01:00
README.md Correct path for project mdx files 2020-04-24 10:53:13 -04:00

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:
    • npm
    • Gatsby: npm i -g gatsby-cli
    • git clone https://github.com/matrix-org/matrix.org && cd matrix.org
  2. cd gatsby
  3. Run npm i to install dependencies
  4. 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

  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|sdks|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!