Cloud-Sync Markdown Editor

Table of Contents

1. About The Project
   • Features
   • Built With
2. Development
3. Usage
4. License
5. Contact

About The Project

A simple, beautiful, and cross-platform Markdown editor with cloud storage synchronization.

Features

• Cross-platform support: Edit a Markdown on different OS: Mac, Windows, and Linux.
• Basic features: Read and edit standard Markdown files.
• Other useful editor features: File search, side-by-side preview, image insert, code blocks, list insert, text bold, italic, quote, etc.
• Cloud auto-sync: Automatically upload files to cloud storage. Azure is only supported for now, AWS and Dropbox supports are in-progress.
• Auto-upgrade: Automatic user notification for version upgrade.

Built With

• Electron
• React
• SimpleMDE
• electron-builder
• Microsoft Azure Storage SDK

Development

• install npm

• install git

• How to build and debug:

  npm install: setup all the dependencies
  npm run dev: run and test locally
  npm run dist: build a binary locally

• How to release:

  npm run release: build and release binary distributions to Github (please replace the GH_TOKEN with your Github personal access token in package.json).

Usage

• Real-time Preview
  
  
  
  
• Side-by-side Preview
  
  
  
  
• Cloud Auto-sync
  
  
  
  

License

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

Contact

Project Link: https://github.com/cutePanda123/cloud-markdown-editor