Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.03 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.03 KB

mdow 🌾

A meadow for your markdown on web.

A lightweight, browser-based markdown editor and previewer that makes sharing markdown files as simple as sharing a link.

Try mdow 🌾

Features ✨

  • 👀 Preview markdown
  • 🔗 Shareable links that last for 30 days
  • 🚀 Fast and lightweight
  • 💻 Simple local development setup

Development 🏗️

  1. Clone the repository
git clone https://github.com/yree/mdow.git
cd mdow
  1. Build the project
cargo build
  1. Run the project with hot-reload:
cargo watch -x run

Then open your browser and navigate to http://localhost:8081

Contributing 🤝

Feel free to report bugs or send pull requests over on GitHub at yree/mdow. Please adhere to the Contributor Covenant code of conduct.

License 📃

mdow is open-source software licensed under the MIT License.