Skip to content

Repository files navigation

GitLiMP

GitLiMP

Live Markdown preview that matches GitHub — no pushes, no setup, one binary.

LICENSE Latest Release Platforms

GitLiMP - Preview Markdown exactly as GitHub renders it | Product Hunt

🌐 Try GitLiMP in Browser

GitLiMP Main Preview

How to Use it?

Simple. Just open a Markdown file from any project you're working on. GitLiMP tracks changes in real-time as you edit and save. It even has a Split View feature that lets you compare two documents side-by-side.

This software is solely made to preview markdown files live while editing in your preferred editor, while applying GitHub-rich rendering to provide what you see on GitHub without having to keep pushing changes to GitHub just because of the Markdown file.

The Recent Files feature allows you to quickly switch between recently opened files... and can be cleared if its cluttered.

GitLiMP is ideal for the following things: Markdown-only repositories where the main purpose is on Curations/Lists, and Styling the README to further provide info about the project, without "pushing" a lot of commits just to Preview the README on GitHub.

Key Features

Split View
Split View
Dark Mode Rendering
Dark Mode Rendering

Keybinds

Action Key
Open Files Ctrl+O
Toggle Split View Ctrl+\

Installation

Currently Available Platforms

  • Windows [Portable .EXE or installer]
  • macOS [Portable .app bundle]
  • Linux [Portable Binary or .DEB/RPM installer]
  • AppImage
  • Flatpak

You can get the Binaries from the GitHub Releases page.

Windows Installation Issues

Important

Some third-party antivirus software (e.g., McAfee, Norton) may flag GitLiMP as "unknown" because the binaries aren't code-signed. This is a false positive — the source is open as well as downloadable from the Main page, or the Releases page. Windows Defender does not flag it. If your AV/SmartScreen warns, allow the app through or run it via "More info → Run anyway".

AppImage Installation Issues

Note

AppImages require FUSE. Install it with:

sudo apt install fuse libfuse2          # Debian/Ubuntu
sudo dnf install fuse fuse-libs         # Fedora/RHEL

If you can't install FUSE, extract and run instead:

./gitlimp-1.0.0-x86_64.AppImage --appimage-extract
cd squashfs-root && ./AppRun

Flatpak Installation

Note

Flathub support is not added yet, so installing this Flatpak package requires this command:

flatpak install gitlimp-X.X.X-x86_64.flatpak  # Where X.X.X is version name.

Contributing

Check out the contributing guide to learn how to contribute to GitLiMP.