Skip to content

markit is a minimal markdown editor that get synced with local files. You just need to import your markdown file and any changes made will be automatically saved to local file.

License

Notifications You must be signed in to change notification settings

Ayyoub-ESSADEQ/markit

Repository files navigation

Markit

Markit is a minimal markdown editor that gets synced with local files. You just need to import your markdown file, and any changes made will be automatically saved to the local file.

Why?

I have tested many other open-source projects for online markdown editors, but unfortunately, all of them only support uploading and persisting changes to cloud storage like Google Drive, Dropbox, and so on.

I'm a huge fan of the local-first approach, so I committed to building this app. It didn't take long, but I hope it will provide the necessary functionality to mimic normal markdown editors.

How It Works

The idea behind Markit is that you can import or create markdown files and be able to make changes persist on your local system with an auto-save option.

I achieved these functionalities by combining two things: a markdown editor and the File System Access API.

  • Markdown editor: To implement markdown editor features, I relied on Lexical, a rich text editor recently created by Facebook. When the user wants to import a markdown file, I read the file content and use $convertFromMarkdownString to convert the markdown text file to an editorState so that Lexical can render it properly.

  • File System Access API: This is a web API that allows access to users' local files so that they can import, create, and persist changes to the imported files.

Credits

  • Lexical: A modern text editor developed by Facebook, designed for flexibility and extensibility.
  • Text Editor: A demo created by Peter LePage showcasing the capabilities of the File System Access API.

About

markit is a minimal markdown editor that get synced with local files. You just need to import your markdown file and any changes made will be automatically saved to local file.

Resources

License

Stars

Watchers

Forks