All Projects → rhysd → Shiba

rhysd / Shiba

Rich markdown live preview app with linter

Programming Languages

typescript
32286 projects

Projects that are alternatives of or similar to Shiba

Issues
Caret issues
Stars: ✭ 326 (-52.82%)
Mutual labels:  markdown, desktop-app
Nyaovim
Web-enhanced Extensible Neovim Frontend
Stars: ✭ 2,166 (+213.46%)
Mutual labels:  desktop-app, polymer
Elements
⚛⚗ A desktop App which displays the periodic table
Stars: ✭ 131 (-81.04%)
Mutual labels:  desktop-app, polymer
Vscode Mdx Preview
MDX Preview for Visual Studio Code
Stars: ✭ 103 (-85.09%)
Mutual labels:  markdown, preview
EasyTongue
😛💬 A translation app built with Electron and Polymer
Stars: ✭ 23 (-96.67%)
Mutual labels:  desktop-app, polymer
Markdown Preview.nvim
markdown preview plugin for (neo)vim
Stars: ✭ 2,858 (+313.6%)
Mutual labels:  markdown, preview
Livedown
Live Markdown previews for your favorite editor.
Stars: ✭ 740 (+7.09%)
Mutual labels:  markdown, preview
quickmd
Quickly preview a markdown file
Stars: ✭ 24 (-96.53%)
Mutual labels:  desktop-app, preview
Vim Markdown Preview
A light Vim plugin for previewing markdown files in a browser - without leaving Vim.
Stars: ✭ 530 (-23.3%)
Mutual labels:  markdown, preview
Vue Preview
A Vue Integrated PhotoSwipe Image Preview Plugin
Stars: ✭ 639 (-7.53%)
Mutual labels:  preview
Tinacms
Open source editor that brings visual editing into React websites. A developer-centric CMS to build contextual and intuitive editing experience without sacrificing code quality.
Stars: ✭ 6,804 (+884.66%)
Mutual labels:  markdown
Md2pdf
Offline markdown to pdf, choose -> edit -> transform 🥂
Stars: ✭ 632 (-8.54%)
Mutual labels:  markdown
Readme
README文件语法解读,即Github Flavored Markdown语法介绍
Stars: ✭ 5,812 (+741.1%)
Mutual labels:  markdown
Lint Md
📚 检查中文 markdown 编写格式规范的命令行工具,基于 AST,方便集成 ci,写博客 / 文档必备。支持 API 调用!
Stars: ✭ 662 (-4.2%)
Mutual labels:  markdown
Markdown Mode
Emacs Markdown Mode
Stars: ✭ 634 (-8.25%)
Mutual labels:  markdown
Backslide
💦 CLI tool for making HTML presentations with Remark.js using Markdown
Stars: ✭ 679 (-1.74%)
Mutual labels:  markdown
Hacktoberfest
Participate in Hacktoberfest by contributing to any Open Source project on GitHub! Here is a starter project for first time contributors. #hacktoberfest
Stars: ✭ 631 (-8.68%)
Mutual labels:  markdown
Discount
My C implementation of John Gruber's Markdown markup language
Stars: ✭ 628 (-9.12%)
Mutual labels:  markdown
Ngx Markdown
Angular markdown component/directive/pipe/service to parse static, dynamic or remote content to HTML with syntax highlight
Stars: ✭ 687 (-0.58%)
Mutual labels:  markdown
Mdmath
LaTeX Math for Markdown inside of Visual Studio Code.
Stars: ✭ 675 (-2.32%)
Mutual labels:  markdown

shibainu

npm version Build Status dogs respected

Shiba is a rich live markdown preview app with linter. It watches markdown files in specific directory and automatically shows the preview and result of lint. Shiba is built on Electron and Polymer.

  • [x] Isolated app. You need not prepare Chrome and can use favorite editor
  • [x] Rich GitHub Flavored Markdown
    • code highlight
    • emoji
    • task list
    • links with tooltip
    • tree diagram and flowchart using mermaid
    • math rendering using katex
  • [x] Live reload
  • [x] Automatic lint (remark-lint, markdownlint)
  • [x] Keyboard shortcuts; All operations are ready for mouse and keyboard.
  • [x] Both GUI and CLI friendly
  • [x] Cross platform (OS X, Linux, Windows)
  • [x] Easy to install
  • [x] Customizable with YAML config file
    • keyboard shortcuts
    • linter
    • user CSS
    • code theme
    • etc...
  • [x] Search text in preview
  • [x] Outline window
  • [x] Print preview (to a paper / to a PDF file)
  • [x] Support multi japanese encodings (utf8, utf16, sjis, euc-jp, unicode)
  • [x] HTML preview
  • [x] Dog-respected 🐕

Documents

All documents are in docs directory. And I wrote a Japanese blog post.

Overview

main screenshot

  1. At start up, Shiba is watching the current working directory (the path is in title of window).
  2. When you edit the markdown file in current working directory, Shiba finds the update, renders the file in window and sets the result of lint.
  3. You can see the result of lint by clicking the '!' button in menu. When the button is red, it means that linter reported some errors.
  4. You can change the watching directory/file using 'directory' button in menu or dropping file to window.
  5. You can quit app by closing the window.

This is the simplest use case. Please see usage document for more detail.

Special Thanks

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.

In packaged app, Electron part is licensed with below notice:

Copyright (c) 2014 GitHub Inc.

Emojis were brought from gemoji project:

octocat, squirrel, shipit Copyright (c) 2013 GitHub Inc. All rights reserved.

bowtie, neckbeard, fu Copyright (c) 2013 37signals, LLC. All rights reserved.

feelsgood, finnadie, goberserk, godmode, hurtrealbad, rage 1-4, suspect Copyright (c) 2013 id Software. All rights reserved.

trollface Copyright (c) 2013 [email protected] All rights reserved.

Source code:

Copyright (c) 2013 GitHub, Inc.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].