Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.17 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.17 KB

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.

Steps

  1. Clone the repository:
    git clone https://github.com/hacimertgokhan/rust-live-md.git
    cd rust-live-md
  2. Install dependencies and run the project:
    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


📜 Roadmap

  • Live Markdown editor.
  • 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:
📧 hacimertgokhan@gmail.com