MiniMark : The CLI Markdown Editor / Viewer

🔷 Installation of Pre-requisites

1. Install NVM Package Manager :

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

2. Install Pupetteer :

npx puppeteer browsers install chrome-headless-shell

3. Install Mermaid CLI :

npm install -g @mermaid-js/mermaid-cli

4. Install Ripgrep Utility :

sudo apt install ripgrep

5. 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

• Official Webpage & Documentation : https://xbais.net/minimark.html
• PyPI : https://pypi.org/project/minimark/0.0.1.2/#description