Skip to content

Realtime collaboration for Markdown documents backed by Matrix rooms

License

Notifications You must be signed in to change notification settings

kalkspace/marktrix

Repository files navigation

Collaborative Markdown docs in Matrix rooms

We are aiming to implement realtime collaboration using Markdown documents where the backend implementation is provided by any Matrix homeserver.

This means:

  • This app doesn't need a specialized backend
  • Works with any existing homeserver implementation
  • End-to-end encryption will be possible (not yet implemented)

Implementation

This is a basic React-based app using the official Matrix Javascript SDK.

The toolchain uses Vite with SWC.

Authentication

The current demo only implements password-based login. If you don't trust the Demo we'd suggest using a throwaway Matrix account for the time being.

We plan to eventually implement OAuth 2.0 dynamic client registration so that you can use OAuth with whatever homeserver. Currently the MSC is pending and is waiting for implementation.

License

This project is licensed under the 3-clause BSD license, see LICENSE