Skip to content

Latest commit

 

History

History
58 lines (52 loc) · 2.24 KB

README.md

File metadata and controls

58 lines (52 loc) · 2.24 KB
Raw

MiniMark : The CLI Markdown Editor / Viewer

OS Python Version License version

Sublime's custom image

Light Mode Dark Mode Markdown Editor

🔷 Installation of Pre-requisites

  1. Install NVM Package Manager :
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
  1. Install Pupetteer :
npx puppeteer browsers install chrome-headless-shell
  1. Install Mermaid CLI :
npm install -g @mermaid-js/mermaid-cli
  1. Install Ripgrep Utility :
sudo apt install ripgrep
  1. Install Kitty :
sudo apt install kitty

🔷 Installation & Usage

  • For Ubuntu < 24.04 LTS : pip3 install minimark
  • For Ubuntu == 24.04 LTS : pip3 install minimark --break-system-packages (NOTE : Ubuntu 24 does not allow installing any python packages without the additional flag, but rest assured : IT IS SAFE, if you dont want this, you can install Minimark in a separate Python venv)

Usage

To open a markdown file with minimark, simply...

  1. Open the Kitty terminal emulator.
  2. Within Kitty, use the command : minimark -file /location/to/my_markdown_file.md

🔷 Features

(🟢 = Impemented, 🔵 = May work, but hasn't been tested, 🟠 = Upcoming)

  • Dark mode support 🟢
  • Latex support 🟢
  • Mermaid Diagram Support 🟢
  • Windows Support 🔵
  • TODO support 🟠
  • Git versioning support 🟠
  • Export to other formats (PDF / Word / HTML / Latex) 🟠
  • Rich Email support 🟠
  • Online File Sync 🟠
  • Online collaboration 🟠
  • SSH support (can work over SSH) 🔵

🔷 Links