Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yree/mdow
🌾 your markdown on web
https://github.com/yree/mdow
htmx-app markdown mash
Last synced: 14 days ago
JSON representation
🌾 your markdown on web
- Host: GitHub
- URL: https://github.com/yree/mdow
- Owner: yree
- License: mit
- Created: 2024-10-02T11:10:58.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-30T12:15:27.000Z (about 1 month ago)
- Last Synced: 2024-11-30T13:22:14.207Z (about 1 month ago)
- Topics: htmx-app, markdown, mash
- Language: Rust
- Homepage: http://yree.io/mdow/
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
git clone https://github.com/yree/mdow.git
cd mdow
```
2. Build the project
```bash
cargo build
```
3. Run the project with hot-reload:
```bash
cargo watch -x run
```
Then open your browser and navigate to [http://localhost:8081](http://localhost:8081)
## Contributing 🤝
Feel free to report bugs or send pull requests over on GitHub at [yree/mdow](https://github.com/yree/mdow). Please adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
## License 📃
`mdow` is open-source software licensed under the [MIT License](LICENSE).