matrix-org/canitmatrix

Can it matrix ... the differen features the matrix ecosystem entities supports

Can it matrix

can it matrix provides a quick and easy way to discover who supports what feature in the matrix ecosystem.

This runs on Jekyll as GitHub Pages site with a home made theme. The site uses Sass for CSS compilation.

Tasks

• clean up
• add our modi
  • servers
  • clients
  • SDKs
  • appservices / bridges
• fetch inital list of MSCs
• fix embedding support
• publish first draft version
• update metadata, footer, legal

Installation

1. Clone the repository.

git clone https://github.com/matrix-org/canitmatrix.git

See Cloning a repository on GitHub documentation. If you're not familiar with Git or GitHub, I strongly encourage you to try GitHub's desktop app on macOS, Windows or Linux.

2. Install Jekyll.

gem install bundler jekyll

See Jekyll Installation Guide.

3. Run Jekyll.

bundle exec jekyll serve

You can turn on incremental regeneration with the --incremental flag.

bundle exec jekyll serve --incremental

The embed version of the site (embed.caniemail.com) is built by specifiying the config file to use.

bundle exec jekyll serve --config _config.embed.yml

4. Go to http://localhost:4000.

Usage

Folders structure

Here is a quick overview of the project's folders structure:

• Data:

  • _data: Data files used throughout the site. This is mainly for settings and labels.
  • _features: Data for every features support.
  • _posts: Data for the latest news.

• Layout:

  • _includes: Files included in other theme files.
  • _layouts: The main layouts of the site.
  • _sass: Sass files. All files will be compiled into one in the assets/css/ folder.
  • assets: CSS, images, and JavaScript files.

Credits

This is a fork of the amazing can I email project by HTeuMeuLeu, adapted for the matrix ecosystem.

Licence

MIT Licence