Skip to content

Commit

Permalink
include alerts syntax in supported features
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Jun 14, 2024
1 parent 4dc676f commit e371255
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
14 changes: 8 additions & 6 deletions v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ It is designed for simplicity, performance, keyboard-friendliness.

Features:

- [GitHub-flavored Markdown][gfm] support; Emoji, Table, Math expressions with [Mathjax][mathjax], Diagrams with [mermaid.js][mermaid], ...
- Automatically update preview when the file is updated by efficiently watching files or directories using OS-specific filesystem
events (FSEvents, inotify, ...)
- [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, ...). Type `?` to know
all shortcuts
- Sections outline in side navigation bar. The current section is automatically focused
- 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 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][rust]. View logic written in [TypeScript][ts] and [React][react] runs on
Expand Down Expand Up @@ -54,3 +55,4 @@ This software is distributed under [the MIT license](./LICENSE).
[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
5 changes: 3 additions & 2 deletions v2/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Note: If you install `.deb` file through `dpkg` command, these dependencies are
### Windows

Shiba uses [WebView2 component][webview2]. Usually it is already installed because Windows 11 and recent Windows 10
installs it by default. When you see Shiba crashes on startup, please check if WebView2 is installed.
install it by default. When you see Shiba crashes on startup, please check if WebView2 is installed.

### macOS

Shiba uses WKWebView and it is installed by default on macOS. No additional dependency is necessary.
Shiba uses [WKWebView][wkwebview] and it is installed by default on macOS. No additional dependency is necessary.

## Use Pre-built binaries

Expand Down Expand Up @@ -113,6 +113,7 @@ make shiba_amd64.deb

[wry]: https://github.com/tauri-apps/wry
[webview2]: https://developer.microsoft.com/en-us/microsoft-edge/webview2/
[wkwebview]: https://developer.apple.com/documentation/webkit/wkwebview
[cargo]: https://doc.rust-lang.org/cargo/
[rustup]: https://rustup.rs/
[nodejs]: https://nodejs.org/en
Expand Down

0 comments on commit e371255

Please sign in to comment.