Skip to content

alagrede/meditee

Repository files navigation

About Meditee

Meditee Desktop app is a minimalist 'Medium like' Markdown editor, based on Draft.js and specifically on medium-draft.

The goal of this project is to provide a working desktop application using the awesome Draftjs through Electron to edit Markdown files.

Download

Stable version

Mac [x64] [arm64]
Windows x64
Linux x64

Built With

(back to top)

Getting Started

  1. Clone the repo
    git clone https://github.com/alagrede/meditee.git
  2. Install NPM packages
    npm install
  3. Run app
    npm start
  4. Packaging app
    npm run package

Roadmap

  • Add Markdown read/write support
  • Add "Open with"
  • Add Code highlight
  • Figure out how to properly reset the contentState to avoid reloading the application when changing file
  • Add Frontmatter support
  • Add Mermaid support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @alagrede - lagrede.anthony@gmail.com

Project Link: https://github.com/alagrede/meditee

(back to top)