Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hacimertgokhan/rust-live-md
Powerful and lightweight application for live previewing and editing markdown files.
https://github.com/hacimertgokhan/rust-live-md
markdown markdown-to-html preview rust-cli rust-cli-apps rust-lang websocket
Last synced: 27 days ago
JSON representation
Powerful and lightweight application for live previewing and editing markdown files.
- Host: GitHub
- URL: https://github.com/hacimertgokhan/rust-live-md
- Owner: hacimertgokhan
- Created: 2024-11-27T10:38:06.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-11-27T10:38:53.000Z (about 1 month ago)
- Last Synced: 2024-11-27T11:31:33.867Z (about 1 month ago)
- Topics: markdown, markdown-to-html, preview, rust-cli, rust-cli-apps, rust-lang, websocket
- Language: Rust
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rust Live MD
**Rust Live MD** is a powerful and lightweight application for **live previewing** and editing Markdown documents. Built with Rust, it combines high performance with a user-friendly experience, enabling you to write Markdown effortlessly while viewing the rendered output in real-time.
---
## 🚀 Features
- **Live Preview:** See the rendered Markdown as you write in real time.
- **Lightweight and Fast:** Leverages Rust's performance for smooth operation.
- **Cross-Platform:** Works seamlessly on Linux, Windows, and macOS.
- **Clean Interface:** Minimalistic design to keep you focused.
- **File Support:** Open, edit, and save Markdown files.
- **Theme Options:** Switch between light and dark themes.
---
## 📂 Installation
### Prerequisites
- **Rust** should be installed. You can install Rust from [here](https://www.rust-lang.org/tools/install).
### Steps
1. Clone the repository:
```bash
git clone https://github.com/hacimertgokhan/rust-live-md.git
cd rust-live-md
```
2. Install dependencies and run the project:
```bash
cargo run
```
3. The application is now ready! 🎉
---
## 📖 Usage
1. Select an existing Markdown file or create a new one.
2. Edit your content in the left panel.
3. View the live preview on the right panel.
4. Save your file using the **"Save"** button or keyboard shortcuts.
---
## 🛠️ Technical Details
- **Language:** Rust
- **Libraries:**
- [`pulldown-cmark`](https://crates.io/crates/pulldown-cmark): Markdown parser.
- [`warp`](https://crates.io/crates/warp): HTTP server.
- [`tokio`](https://crates.io/crates/tokio): Asynchronous runtime.
---
## 📜 Roadmap
- [x] Live Markdown editor.
- [x] File saving and opening functionality.
- [ ] Additional theme options.
- [ ] Markdown syntax shortcuts.
- [ ] Plugin support.
---
## 👥 Contributing
Contributions are welcome! Feel free to open an **Issue** or submit a **Pull Request**. Feedback is always appreciated.
---
## 📝 License
This project is licensed under the **MIT License**. See the `LICENSE` file for more details.
---
## 📧 Contact
If you have any questions or suggestions, feel free to reach out:
📧 **[email protected]**