Iquity

A cross-platform markdown previewer.

Why should I use it?

• slides
• syntax highlighting on code snippets
• config.toml file
• 📂 PDF Export - Printable markdown preview. 📂
• 📂 HTML Export. 📂
• 🦀 Rusty - Built with Rust, frontend and backend. 🦀

How is it made?

• Leptos - A web application framework.
• Tauri - A desktop application framework.

---

how to install it

at the moment. building from source is the only option

Prerequisites

1. install Rust
2. make sure your machine have Tauri V2 Prerequisites

Installing

  git clone --depth=1 https://github.com/mahmoud-eltahawy/Iquity.git
  cd iquity
  cargo install trunk
  rustup target add wasm32-unknown-unknown
  cargo install tauri-cli --version "^2.0.0-rc"
  cargo tauri build

1. the builded program is called iquity located at ./target/release/iquity
2. you just move it to a directory that is in your path

---

how to use it

  iquity # will print help messge
  # you should use it like this
  iquity PATH_TO_README_FILE.md
  # or like this
  iquity PATH_TO_DIRECTORY_THAT_CONTAINS_FILE_NAMED_index.md

• after the window is launched you can press slash key for help