Skip to content

yree/mdow

Repository files navigation

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.