{"id":15387336,"url":"https://github.com/rhysd/shiba","last_synced_at":"2026-04-02T16:34:39.241Z","repository":{"id":34629737,"uuid":"38579767","full_name":"rhysd/Shiba","owner":"rhysd","description":"Rich markdown live preview app with linter","archived":false,"fork":false,"pushed_at":"2025-04-11T13:47:21.000Z","size":15741,"stargazers_count":781,"open_issues_count":8,"forks_count":55,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-04-12T01:56:06.995Z","etag":null,"topics":["desktop-app","electron","markdown","polymer","preview"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rhysd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-05T18:42:58.000Z","updated_at":"2025-04-11T13:47:25.000Z","dependencies_parsed_at":"2024-01-02T15:48:46.841Z","dependency_job_id":"af1c7312-73d6-4d6c-980a-0b8edc222a62","html_url":"https://github.com/rhysd/Shiba","commit_stats":{"total_commits":1018,"total_committers":6,"mean_commits":"169.66666666666666","dds":0.01080550098231825,"last_synced_commit":"ec514bfa03ce80d159e13a779841d198b82e56d0"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2FShiba","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2FShiba/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2FShiba/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2FShiba/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhysd","download_url":"https://codeload.github.com/rhysd/Shiba/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505864,"owners_count":21115354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["desktop-app","electron","markdown","polymer","preview"],"created_at":"2024-10-01T14:53:39.722Z","updated_at":"2026-04-02T16:34:39.231Z","avatar_url":"https://github.com/rhysd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![icon](assets/icon.iconset/icon_64x64.png) Shiba\n=================================================\n[![CI][ci-badge]][ci]\n[![dogs respected][shiba-badge]][shiba]\n[![crates.io][crates-io-badge]][crates-io]\n\n\u003e [!WARNING]\n\u003e Shiba v2 is a work in progress\n\n[Shiba][shiba] is a simple [Markdown][gh-markdown] browser to preview documents with your favorite text editor.\nIt is designed for simplicity, performance, keyboard-friendly navigations.\n\n![Screenshot of light/dark windows](https://raw.githubusercontent.com/rhysd/ss/master/Shiba/main.jpg)\n\nFeatures:\n\n- [GitHub-flavored Markdown][gfm] support; Emojis, Table, [Alerts][alerts], Math expressions with [Mathjax][mathjax], Diagrams with\n  [mermaid.js][mermaid], ...\n- Watch the files or directories and automatically update the preview efficiently using OS-specific filesystem events\n  (FSEvents, inotify, ...)\n- Automatically scroll to the last modified position\n- All features can be accessed via keyboard shortcuts (scroll the article, search text, jump to section, go forward/back history...).\n  Type `?` to know all shortcuts\n- Sections outline in side navigation bar highlighting the current section\n- Both CLI and GUI friendly; Available as a single binary executable as well as an installable desktop application\n- Performance critical part (parsing Markdown text, searching Markdown AST, calculating the last modified position, ...) and\n  core application logic are written in [Rust][rust]. Thin view logic is written in [TypeScript][ts] \u0026 [React][react] and runs on\n  platform-specific WebView\n- Multiple windows support to open multiple documents simultaneously\n- Cross platform; macOS, Windows, Linux are supported\n- Customizable with [a YAML config file](./src/assets/default_config.yml) (color theme, keyboard shortcuts, custom CSS, ...)\n- Dogs are respected :dog2:\n\n## Documentation\n\nAll documentations are in the [docs](./docs) directory.\n\n- [Installation](./docs/installation.md)\n- ...More docs will be added\n\n## About v2\n\nShiba v2 is the complete rewrite of v1 using Rust and platform-specific WebView. For v1, please visit [the `v1` branch][v1].\n\n## License\n\nThis software is distributed under [the MIT license](./LICENSE).\n\n[ci]: https://github.com/rhysd/Shiba/actions/workflows/watchdogs.yml\n[ci-badge]: https://github.com/rhysd/Shiba/actions/workflows/watchdogs.yml/badge.svg\n[shiba-badge]: https://img.shields.io/badge/dogs-respected-brightgreen.svg?longCache=true\u0026style=flat\n[shiba]: https://github.com/rhysd/Shiba\n[crates-io-badge]: https://img.shields.io/crates/v/shiba-preview\n[crates-io]: https://crates.io/crates/shiba-preview\n[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\n[gfm]: https://github.github.com/gfm/\n[mathjax]: https://www.mathjax.org/\n[mermaid]: https://mermaid.js.org/\n[rust]: https://www.rust-lang.org/ja\n[ts]: https://www.typescriptlang.org/\n[react]: https://react.dev/\n[v1]: https://github.com/rhysd/Shiba/tree/v1\n[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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fshiba","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhysd%2Fshiba","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fshiba/lists"}