https://github.com/rhysd/shiba
Rich markdown live preview app with linter
https://github.com/rhysd/shiba
desktop-app electron markdown polymer preview
Last synced: 2 months ago
JSON representation
Rich markdown live preview app with linter
- Host: GitHub
- URL: https://github.com/rhysd/shiba
- Owner: rhysd
- Created: 2015-07-05T18:42:58.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T13:47:21.000Z (about 1 year ago)
- Last Synced: 2025-04-12T01:56:06.995Z (about 1 year ago)
- Topics: desktop-app, electron, markdown, polymer, preview
- Language: TypeScript
- Homepage:
- Size: 15 MB
- Stars: 781
- Watchers: 23
- Forks: 55
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
 Shiba
=================================================
[![CI][ci-badge]][ci]
[![dogs respected][shiba-badge]][shiba]
[![crates.io][crates-io-badge]][crates-io]
> [!WARNING]
> Shiba v2 is a work in progress
[Shiba][shiba] is a simple [Markdown][gh-markdown] browser to preview documents with your favorite text editor.
It is designed for simplicity, performance, keyboard-friendly navigations.
Features:
- [GitHub-flavored Markdown][gfm] support; Emojis, Table, [Alerts][alerts], Math expressions with [Mathjax][mathjax], Diagrams with
[mermaid.js][mermaid], ...
- 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][rust]. Thin view logic is written in [TypeScript][ts] & [React][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](./src/assets/default_config.yml) (color theme, keyboard shortcuts, custom CSS, ...)
- Dogs are respected :dog2:
## Documentation
All documentations are in the [docs](./docs) directory.
- [Installation](./docs/installation.md)
- ...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][v1].
## License
This software is distributed under [the MIT license](./LICENSE).
[ci]: https://github.com/rhysd/Shiba/actions/workflows/watchdogs.yml
[ci-badge]: https://github.com/rhysd/Shiba/actions/workflows/watchdogs.yml/badge.svg
[shiba-badge]: https://img.shields.io/badge/dogs-respected-brightgreen.svg?longCache=true&style=flat
[shiba]: https://github.com/rhysd/Shiba
[crates-io-badge]: https://img.shields.io/crates/v/shiba-preview
[crates-io]: https://crates.io/crates/shiba-preview
[gh-markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
[gfm]: https://github.github.com/gfm/
[mathjax]: https://www.mathjax.org/
[mermaid]: https://mermaid.js.org/
[rust]: https://www.rust-lang.org/ja
[ts]: https://www.typescriptlang.org/
[react]: https://react.dev/
[v1]: https://github.com/rhysd/Shiba/tree/v1
[alerts]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts