Shiba

[icon] Shiba

[CI] [dogs respected] [crates.io]

[!WARNING] Shiba v2 is a work in progress

Shiba is a simple Markdown browser to preview documents with your favorite text editor. It is designed for simplicity, performance, keyboard-friendly navigations.

[Screenshot of light/dark windows]

Features:

• GitHub-flavored Markdown support; Emojis, Table, Alerts, Math expressions with Mathjax, Diagrams with mermaid.js, ...
• Watch the files or directories and automatically update the preview efficiently 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, go forward/back history...). Type ? to know all shortcuts
• Sections outline in side navigation bar highlighting the current section
• Both CLI and GUI friendly; Available as a single binary executable as well as an installable desktop application
• Performance critical part (parsing Markdown text, searching Markdown AST, calculating the last modified position, ...) and core application logic are written in Rust. Thin view logic is written in TypeScript & React and runs on platform-specific WebView
• Multiple windows support to open multiple documents simultaneously
• Cross platform; macOS, Windows, Linux are supported
• Customizable with a YAML config file (color theme, keyboard shortcuts, custom CSS, ...)
• Dogs are respected :dog2:

Documentation

All documentations are in the docs directory.

• Installation
• ...More docs will be added

About v2

Shiba v2 is the complete rewrite of v1 using Rust and platform-specific WebView. For v1, please visit the v1 branch.

License

This software is distributed under the MIT license.