Shiba is a rich live markdown preview app with lint. It watches markdown files in specific directory and automatically shows the preview and result of lint. Shiba is built on Electron and Polymer.
- Isolated app. You need not prepare Chrome and can use favorite editor.
- Rich GitHub Flavored Markdown (code highlight, emoji, tree diagram and flowchart using mermaid, math rendering using katex)
- Live reload
- Automatic lint (mdast-lint, markdownlint)
- Cross platform (Mac, Linux, Windows)
- Both GUI and CLI friendly.
- Easy to install
- Keyboard shortcuts
- Customizable with YAML config file (keyboard shortcuts, linter, etc)
- Print preview (to paper / to PDF file)
- HTML preview
- Dog-respected 🐕
All documents are in docs directory. And I wrote a Japanese blog post.
Installation
You can install Shiba easily. Please see installation document.
Usage
- At start up, Shiba is watching the current working directory (watching directory is shown in title of window).
- When you edit the markdown file in current working directory, Shiba finds the update, renders the file in window and set the result of lint.
- You can see the result of lint by pushing the '!' button in right above of window. When the button is red, it means that linter reported some errors.
- You can change the watching directory/file using 'directory' button in right above of window or dropping file to window. Watching path is shown in title of window.
- You can quit app by closing the window.
Please see usage document for more detail.
Keyboard Shortcuts
Keyboard shortcuts are available for above all operations. Please refer shortcuts document.
Customization
You can customize Shiba by making YAML configuration file. Please refer customization document.
TODOs
- Outline
- Search
- More markdown theme (e.g. tufte-css)
- More formats
- PDF with PDF.js
- org
- Separate converter as plugin
- Watch multiple paths (Now Shiba can only one directory or file)
Special Thanks
- The logo of this app came from いらすとや.
- This app was inspired by @mattn's mkup.
- This app refers vmd a lot, which is a very simple markdown preview app built on Electron.
- Emoji pictures are from arvida/emoji-cheat-sheet.com.
- The voice resource came from 効果音ラボ.
License
MIT License.
Copyright (c) 2015 rhysd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.