Changelog 0006: Turn any* git repo into a collaborative document

Follow us on Twitter and/or Bluesky.

Moment, as a product, has a single aspiration: to be as rich and collaborative as Google Docs or Notion, but based entirely on Markdown files that are stored in a git repository, on your device.

That’s what every document you create in Moment is. But what about git repositories that already exist? Can you edit them, too?

As of today, the answer is yes: you just need to add a moment.yml file to the repository root. And if you use the Moment desktop app, it will do it for you.

First, open the Moment Desktop App, and click the chevron in the top right. Choose Import Git Repository:

Loading...

Second, chose any directory with a .git folder.

Very important that it has a .git folder. That is the whole point of this feature: we let you edit any git repo with markdown files.

If you do not have one off hand, consider cloning the prometheus-operator/runbooks repo: git clone [email protected]:prometheus-operator/runbooks.git.

Loading...

Boom, you can now invite anyone to collaborate on the Markdown files in that document! Just click the Share button in the top right to invite anyone you like.

Loading...

Caveats and known limitations

The title of this post has an asterisk in it. "Turn any* git repo into a collaborative document." What is with the asterisk?

This is a beta feature. You are very likely to run into bugs. If you do, we would love to hear from you! [email protected]

Very limited support for inline HTML. We are working on expanding this support, but until then you are likely to run into bugs when you try to open the doc after importing it. If you let us know, we’ll try to fix it ASAP.

Not quite good enough for utterly enormous docs. Any git repo with thousands of Markdown files is probably not going to be a great experience. If this is important to your repo, let us know, and we’ll try to prioritize your use case.