Shiba is a simple Markdown preview application to be used with your favorite text editor. It is designed for simplicity, performance, keyboard-friendliness.
Features:
- GitHub-flavored Markdown support; Emoji, Table, Math expressions with Mathjax, Diagrams with mermaid.js, ...
- Automatically update preview when the file is updated by efficiently watching files or directories using OS-specific filesystem events (FSEvents, inotify, ...)
- Automatically scroll to the last modified position
- All features can be accessed via keyboard shortcuts (scroll the article, search text, jump to section, ...). Type
?to know all shortcuts - Sections outline in side navigation bar. The current section is automatically focused
- Both CLI and GUI friendly; Available as a single binary executable as well as a desktop application installed to your system
- Performance critical part (parsing Markdown text, searching Markdown AST, calculating the last modified position, ...) and core application logic are written in Rust. View logic written in TypeScript and React runs on platform-specific WebView
- Cross platform; macOS, Windows, Linux are supported
- Customizable with a YAML config file (color theme, keyboard shortcuts, custom CSS, ...)
- Dogs are respected 🐕
All documentations are in the docs directory.
- Installation
- ...More docs will be added
Shiba v2 is the complete rewrite of v1 using Rust and platform-specific WebView. For v1, please visit the v1 branch.
This software is distributed under the MIT license.