What happened:

Shiba shows nothing in the markdown drawing area.

What did you expect to happen:

I have used Shiba from version 1.1.1. It's nice preview application for markdown!. It had no problem. But Shiba shows nothing after I updated it to version 1.2.0. I'm using md files which is ok on version 1.1.1.
I don't use custom config.yml.

How to reproduce it (as minimally and precisely as possible):

I replaced all file to version 1.2.0 from version 1.1.1 in Shiba-win32-x64 folder, and open *.md file.

Environment:

• Shiba version: 1.2.0 Shiba-win32-x64
• OS version: Windows 10 64bit (1709)

とても便利なアプリをありがとうございます。

Version 0.4.0 を使っています。

ダウンロード後すぐに起動したところ、イカの、ではなくて以下のエラーが。

「OK」すると D&D を催促するような画面が出てくるので、ファイルを D&D してみると次のエラーが出ます。

「OK」すると以下。

これ以降は、OK してもずっとこのエラーの繰り返しです。

PS.

関係ないかもしれませんが、最初のエラーが出るまでに数秒あります。その間に D&D すると表示されました。また、今回使った Markdown ファイルは Shiba 添付の README.md と個人的な *.md 数種類（うち一つには html タグが含まれている）です。

It would be useful if Shiba could support standard html tags, such as iframes. It would allow to include a lot of contents (e.g. YouTube, etc...)

It would be nice to have the possibility to open a directory, of which the files are shown in a file panel, perhaps on the left side.

I created a file (pasted below) containing the default examples from the documentation (https://mermaid-js.github.io/mermaid/#/), however only the second one of these (the sequenceDiagram type) seems to work. There do not seem to be any error messages.
Does it maybe have to do with the old mermaid version that is used?

(The current one would be 9.1.1)

Shiba was installed as instructed via npm, with shiba --version

Shiba v1.2.1
Environment:
  OS:       linux-x64
  Electron: 2.0.18
  Chromium: 61.0.3163.100
  Node.js:  8.9.3

# mermaid examples
```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```

```mermaid
gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d
```

```mermaid
gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d

```

```mermaid
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
```

```mermaid
    gitGraph
       commit
       commit
       branch develop
       commit
       commit
       commit
       checkout main
       commit
       commit
```

```mermaid
erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
```

```mermaid
journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 5: Me
```

Never mind, this works fine.

I'm using code blocks but in the preview, they don't look like in Github (with colors).
I'm working with code written in Agda.

Any reason?

Whenever I open Shiba, with or without a file, my CPU percentage goes up to 180%.

Thank you for your such a great project.

I was following the instruction in https://github.com/rhysd/Shiba/blob/master/docs/installation.md#for-development

However I could not build an app without small modifications as follows:

$ gem install slimrb

In my environment (OSX 10.11), I could not find slimrb in gem repository.
So I did install slim instead.

$ gem install slim

# Build Shiba
$ rake build

When I run "rake build", at first it was failed with the following error:

No such file or directory - build/static/builtin-search.html

I need to create build/static directory before build:

# Build Shiba
$ mkdir ./build/static
$ rake build

Probably Rakefile should check existence of the output directory then create it if it's missing.

Regards,
Takuya

Shiba を公開していただき、ありがとうございます。

https://github.com/rhysd/Shiba/blob/master/docs/installation.md#for-development の手順通り、実行したのですが、以下の点でうまくいきませんでしたので、ご報告させていただきます。

$ gem install slimrb

私の環境では slimrb ではインストールできませんでした。

$ gem install slim

でインストールしました。

"rake build" を実行した際、

No such file or directory - build/static/builtin-search.html

というエラーが発生しました。build を実行する前に build/static ディレクトリを作成しておく必要があるようです。

# Build Shiba
$ mkdir ./build/static
$ rake build

Rakefile で出力先ディレクトリの有無を確認して、ない場合はディレクトリを生成するようにした方がいいかもしれません。

以上、よろしくお願いいたします。
大谷

I worked on the icon a little bit, to center the image within the frame, and also to remove a lot of the whitespace around the face. This makes it better for use as an icon. (I think 😄 ) Feel free to use it, if it's helpful.

I just noticed on 0.4.0 release notes the reference to {config dir}/user.css which I assume is custom CSS stylesheet?

If so, perhaps you could place an example CSS in the Documentation so we have reference for all the various CSS selectors available to style Shiba's output. Then I can get started on tufte-css 😄

Repro

1. Open app
2. D&D foo.md file
3. Modify foo.md and check preview is updated
4. D&D foo.js file
5. D&D foo.md file
6. Modify foo.md

Expected

Preview of foo.md is updated

Actual

Preview of foo.md is not updated because watching path is changed to foo.js at 4.

Env

• Shiba version: HEAD
• macOS 10.12

When I check out the project and run the following commands yarn install && yarn start or npm install && npm start then I get the following error. It seems that neither the npm install hooks nor the start does some of the ruby provisioning required to boot the app.

➜  Shiba git:(master) ✗ npm install && npm start

> [email protected] install /Users/agir/code-open/Shiba/node_modules/fsevents
> node install

node-pre-gyp WARN Tried to download(404): https://fsevents-binaries.s3-us-west-2.amazonaws.com/v1.2.4/fse-v1.2.4-node-v67-darwin-x64.tar.gz
node-pre-gyp WARN Pre-built binaries not found for [email protected] and [email protected] (node-v67 ABI, unknown) (falling back to source compile with node-gyp)
  SOLINK_MODULE(target) Release/.node
  CXX(target) Release/obj.target/fse/fsevents.o
In file included from ../fsevents.cc:6:
In file included from ../../nan/nan.h:203:
In file included from ../../nan/nan_new.h:189:
../../nan/nan_implementation_12_inl.h:337:28: warning: 'New' is deprecated: Use Isolate* version [-Wdeprecated-declarations]
  return v8::StringObject::New(value).As<v8::StringObject>();
                           ^
/Users/agir/.node-gyp/11.12.0/include/node/v8.h:5241:3: note: 'New' has been explicitly marked deprecated here
  V8_DEPRECATED("Use Isolate* version",
  ^
/Users/agir/.node-gyp/11.12.0/include/node/v8config.h:326:29: note: expanded from macro 'V8_DEPRECATED'
  declarator __attribute__((deprecated(message)))
                            ^
In file included from ../fsevents.cc:6:
../../nan/nan.h:1034:44: warning: 'ToString' is deprecated: Use maybe version [-Wdeprecated-declarations]
      v8::Local<v8::String> string = from->ToString();
                                           ^
/Users/agir/.node-gyp/11.12.0/include/node/v8.h:2548:10: note: 'ToString' has been explicitly marked deprecated here
  inline V8_DEPRECATED("Use maybe version", Local<String> ToString() const);
         ^
/Users/agir/.node-gyp/11.12.0/include/node/v8config.h:326:29: note: expanded from macro 'V8_DEPRECATED'
  declarator __attribute__((deprecated(message)))
                            ^
In file included from ../fsevents.cc:6:
../../nan/nan.h:1044:27: warning: 'WriteUtf8' is deprecated: Use Isolate* version [-Wdeprecated-declarations]
        length_ = string->WriteUtf8(str_, static_cast<int>(len), 0, flags);
                          ^
/Users/agir/.node-gyp/11.12.0/include/node/v8.h:2753:3: note: 'WriteUtf8' has been explicitly marked deprecated here
  V8_DEPRECATED("Use Isolate* version",
  ^
/Users/agir/.node-gyp/11.12.0/include/node/v8config.h:326:29: note: expanded from macro 'V8_DEPRECATED'
  declarator __attribute__((deprecated(message)))
                            ^
../fsevents.cc:63:6: warning: field 'async_resource' will be initialized after field 'lockStarted' [-Wreorder]
   : async_resource("fsevents:FSEvents"), lockStarted(false) {
     ^
4 warnings generated.
  SOLINK_MODULE(target) Release/fse.node
  COPY /Users/agir/code-open/Shiba/node_modules/fsevents/lib/binding/Release/node-v67-darwin-x64/fse.node
  TOUCH Release/obj.target/action_after_build.stamp

> [email protected] install /Users/agir/code-open/Shiba/node_modules/electron-chromedriver
> node ./download-chromedriver.js

successfully dowloaded and extracted!

> [email protected] postinstall /Users/agir/code-open/Shiba/node_modules/electron
> node install.js

Downloading SHASUMS256.txt
[============================================>] 100.0% of 5.33 kB (5.33 kB/s)
added 834 packages from 1170 contributors and audited 4160 packages in 160.088s
found 43 vulnerabilities (29 moderate, 14 high)
  run `npm audit fix` to fix them, or `npm audit` for details

> [email protected] start /Users/agir/code-open/Shiba
> npm run dep && npm run build && npm run show-readme


> [email protected] dep /Users/agir/code-open/Shiba
> rake dep


> [email protected] build /Users/agir/code-open/Shiba
> rake build

rake aborted!
'slimrb' command doesn't exist
/Users/agir/code-open/Shiba/Rakefile:20:in `ensure_cmd'
/Users/agir/code-open/Shiba/Rakefile:43:in `block in <top (required)>'
Tasks: TOP => build => compile => build_slim
(See full trace by running task with --trace)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] build: `rake build`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/agir/.npm/_logs/2019-04-21T11_49_43_122Z-debug.log
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `npm run dep && npm run build && npm run show-readme`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/agir/.npm/_logs/2019-04-21T11_49_43_176Z-debug.log
➜  Shiba git:(master) ✗

Repro

Open following markdown code in preview

[![Build Status](https://travis-ci.org/rhysd/Shiba.svg?branch=master)](https://travis-ci.org/rhysd/Shiba)

• Clicking
  • Expected: it should navigate to https://travis-ci.org/rhysd/Shiba
  • Actual: it navigates to https://travis-ci.org/rhysd/Shiba.svg?branch=master

Environment

• version 2f1ead8
• macOS 10.12
• Electron 1.7.9

love shiba! was trying to add zoom in and out for a PR, but running into a build issue w/ rake. not familiar w/ the ruby build stuff, but getting issue below, 'slimrb' command doesn't exist

$ npm run start

> [email protected] start /Users/elink/Source/fed/electron/shiba
> npm run dep && npm run build && npm run show-readme


> [email protected] dep /Users/elink/Source/fed/electron/shiba
> rake dep


> [email protected] build /Users/elink/Source/fed/electron/shiba
> rake build

rake aborted!
'slimrb' command doesn't exist
/Users/elink/Source/fed/electron/shiba/Rakefile:20:in `ensure_cmd'
/Users/elink/Source/fed/electron/shiba/Rakefile:43:in `block in <top (required)>'
Tasks: TOP => build => compile => build_slim
(See full trace by running task with --trace)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] build: `rake build`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/elink/.npm/_logs/2019-03-07T20_58_46_672Z-debug.log
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `npm run dep && npm run build && npm run show-readme`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/elink/.npm/_logs/2019-03-07T20_58_46_709Z-debug.log

I downloaded "Shiba-linux-x64.zip" from release page(v.1.0.0),
and then I read LICENSE file.

Copyright (c) 2014 GitHub Inc.

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.

Is this copyrighted by GitHub?
This description is different from repository's README file.

I found printing does not work on shiba because of overflow: auto.

Scroll bar of shiba comes from overflow: auto but it may hide second and subsequent sheets.

This patch may resolve this issue but I don't know this is correct way to fix the issue.

https://github.com/daveliepmann/tufte-css

Tufte is a very distinctive style. I want Shiba to preview markdown document with this style. Shiba now supports only GitHub like style.

• Profiling main and renderer process
• Remove useless initialization
• Defer some initializations at start

Currently Shiba only supports UTF-8 but many documents on Windows are encoded with CP932.

Hey there!

I belong to an open source security research community, and a member (@ning1022) has found an issue, but doesn’t know the best way to disclose it.

If not a hassle, might you kindly add a SECURITY.md file with an email, or another contact method? GitHub recommends this best practice to ensure security issues are responsibly disclosed, and it would serve as a simple instruction for security researchers in the future.

Thank you for your consideration, and I look forward to hearing from you!

(cc @huntr-helper)

Whenever I am attempting to print to pdf on Windows, my machine uses bioPDF to print to pdf. I am able to print a test page with bioPDF, and can print to pdf using Word. I'm unsure if the issue is truly with Shiba, or bioPDF.

Repro

1. Open Shiba's README.md
2. Click some relative link

Env

• OS: Windows 8.1
• Revision: d8562c9

After following the instructions here I run into the following two errors:

/src/node_modules/.bin/tsc --pretty -p ./browser
node_modules/@types/webcomponents.js/index.d.ts:39:9 - error TS2687: All declarations of 'extends' must have identical modifiers.

39         extends?: string;
           ~~~~~~~

That can be resolved by applying the following patch to node_modules/@types/webcomponents.js/index.d.ts:

@@ -36,7 + +36,7 @@
 declare global {
     // This contains duplicates of some types in lib.dom.d.ts in order to support typescript 2.0
     interface ElementDefinitionOptions {
-        extends?: string;
+        extends: string;
     }

     interface ShadowRoot extends DocumentFragment {

And after that

/src/node_modules/.bin/tsc --pretty -p ./renderer
node_modules/marked-sanitizer-github/index.ts:200:46 - error TS2345: Argument of type '{ onopentag: (name: string, attrs: { [s: string]: string; }) => void; oncomment: () => void; }' is not assignable to parameter of type 'DomHandler'.
  Property 'onparserinit' is missing in type '{ onopentag: (name: string, attrs: { [s: string]: string; }) => void; oncomment: () => void; }'.

200     private readonly parser = new HTMLParser({
                                                 ~
201         onopentag: (name, attrs) => {
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...
208         // Note: onerror is not handled because no error occurs while only parsing an opening tag
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209     });
    ~~~~~

To resolve that I needed to add all the callbacks defined by the HTMLParser object to the initialization in node_modules/marked-sanitizer-github/index.ts:

@@ -206,6 +206,15 @@
         },
         // Note: CDATA (cdatastart) is not handled
         // Note: onerror is not handled because no error occurs while only parsing an opening tag
+        onparserinit: () => {},
+        onend: () => {},
+        onreset: () => {},
+        onerror: () => {},
+        onclosetag: () => {},
+        oncommentend: () => {},
+        ontext: () => {},
+        oncdatastart: () => {},
+        onprocessinginstruction: () => {},
     });

     reset() {

Allow user to link markdown file to markdown file. Given a link in file1.md to file2.md when user clicks this link [file2.md](file2.md), auto-load and display file2.md in Shiba.

Again, here is how Markn handle this: minodisk/markn@bf31129

• Markdown Code

[test link](path/to/doc.md#section)

• Sequence

1. Open the document with Shiba
2. Click the link
3. Shiba doesn't show the document of the link

• Environment
  • OS X 10.11.4
  • Shiba 0.10.1

Hello,

I would like to report a XSS vulnerability in your application that leads to code execution.
I have a working POC that I dont want to post publicly.
Please contact me at [email protected]

Hi Shiba developers,

Just a report that some of the emoj are not rendered in Shiba on my macOX Sierra

1. 🏁
2. ✅
3. 💚
4. ⬆️
5. ⬇️

The screenshot is attached as follows

In your documentation, you mentioned that you can use mermaid.js by using mermaid code block, but in the 0.4.0 version of the mac app, this is not possible. When using the mermaid code block, the app simply uses a code block instead of using mermaid.

Am I missing something?

使用するOS、ブラウザ、エディタに捉われずmarkdownをキレイにプレビューできて、かつmermaidが使える、とまさに求めていたものでした。素晴らしいアプリをリリースしてくださり、ありがとうございます。

さて、本題ですがmermaidで書いた図を表示してみると矢印が表示されないことが気になりました。
こちらは既知の問題でしょうか？

Embedding images do not render, this is broken: ![](shiba.png)

VMD can do this, maybe looking at their code would show how to embed images? https://github.com/yoshuawuyts/vmd/blob/bc764bd589d7c31d8a25fd739b65c18bd6c39184/client.js#L9

Thank you.

I am amazed about this software. I searched for exactly such a live preview application. Thank you for this.

But I could not figure out how to render inline math with katex. I tried

Lorem ipsum `\lambda`{.katex}

but it does not work. Is there any war to render inline math with Shiba?

If I drag and drop multiple files into same Shiba window, on the 3rd (and sometimes 4th) drag and drop, the rendering breaks and it only shows just text in monospace font.

Not sure if this is really an issue, since I'm not sure how often drag and drop is used. 😄

Given a Markdown document inside a .folder Shiba cannot see any changes occuring to the document. Only on manual refresh can Shiba see the changes.

For example: writing a temporary Markdown document to ~/.cache/AppName/output.md this file can be opened and manually refreshed inside Shiba but no changes made to that file will be automatically loaded by Shiba's watcher.

However, change that path to a non-hidden/non-dot folder ~/cache/AppName/output.md and Shiba works beautifully, as normal.

Thanks!!

Can't see tail of messages on Windows.

It would be better pop up whole message when mouse cursor on it.

I'm seeing an extra layer of scrollbars in Ubuntu 15.04 Gnome 3.14 GTK+ 3.14

What the title says but using this:

Latex render service

The service above is pretty good and I'm using for some README in github.
Maybe Shiba could support it.

In order to have something like this:

https://upmath.me/

Is there a particular reason why gantt charts have not been implemented since every other feature of mermaid has? It would be awesome!

Running Shiba from a symlinked directory on Windows throws an error.

How to reproduce:

• Download latest release (1.2.1)
• Unzip file
• Run New-Item -ItemType Junction -Name Shiba-Link -Value .\Shiba-win32-x64\ with PowerShell to create symlink
• Start .\Shiba-Link\Shiba.exe

Reported in #26.

I should improve:

1. Replace $HOME path with ~
2. Do not set text-overflow and shortening path without loosing file name (and line number)

Is there an SVG version of the shibainu.png? It would be nice to have it included alongside the png image.

No problem if there is not 😄

When restarting shiba after changed window size and position, it was reseted.

I have realize this with Windows 64bit version.

On my system (Linux) with Shiba downloaded from the release, I get a wrong mermaid rendering:

This is my config.yml (I tried various values of drawer.responive and default configuration)

drawer:
    responsive: false
markdown:
    css_path: '/opt/Shiba-linux-x64/tufte.css'
path_watcher.default_path: '/home/sapo/MEGAsync/SHARED/Notes/General.md'

$ brew cask install shiba

does not work for version 1.2.0 anymore, because of wrong sha256 checksum. Have you changed the binary after first release?

$ brew cask audit --download shiba
==> Downloading https://github.com/rhysd/Shiba/releases/download/v1.2.0/Shiba-darwin-x64.zip
######################################################################## 100.0%
==> Verifying checksum for Cask shiba
==> Note: running "brew update" may fix sha256 checksum errors
audit for shiba: failed
 - download not possible: Checksum for Cask 'shiba' does not match.

Expected: 8d5da51fba5ead6343e4f35532103c6c3cf28b649322d363b3ce188f62886bb4
Actual:   9df054565afadd0b7ae808dd8f47725bacb5737edb9db9ec635150a0398f603f
File:     /Users/xxx/Library/Caches/Homebrew/Cask/shiba--1.2.0.zip

To retry an incomplete download, remove the file above.
Error: audit failed for casks: shiba

I'm loving this tool so far 👍 👍

On my machine I cannot see the line numbers of the lint errors:

It would be nice if it jumped to or highlighted the line and/or jumped to it.

Nice app! Could you, please, add a shortcut for search? All viewers and editors usually have such. It's very inconvenient to reach for the mouse every time you need to find something in the text. Thanks!