search

mermaidjs / mermaid-live-editor

Location has moved to https://github.com/mermaid-js/mermaid-live-editor
https://mermaidjs.github.io/mermaid-live-editor/
MIT License
975 stars 181 forks source link

Could README instruction have more details? #55

Open catcatcatcat opened 5 years ago

catcatcatcat commented 5 years ago

Dear Mermaid Team,

Thank you for the wonderful editor in advance, I love to use mermaid online editor.

My issue is a novice problem.

Sometimes I have no internet connection and cannot use it, in a previous issue #217 https://github.com/knsv/mermaid/issues/217 I saw one of the solutions is run it locally, but I failed in the very first step yarn install with an error msg: "-bash: yarn: command not found".

I am a non-programmer and have little knowledge about what's going on, after I asked my friend, I tried: npm install yarn and run yarn install again with + yarn@1.16.0 but still saw the same error msg.

Then I tried brew install yarn and finally succeeded with yarn install v1.17.0

I think it would be kind if README pointed out you have to install yarn before type yarn install and it would be kinder if add how to install yarn section.

How do you think about it? Thank you so much.

morgen-peschke commented 2 years ago

For anyone who stumbles on this issue, the project has been moved and the new one includes a docker image you can spin up locally to get an offline editor.

See: https://github.com/mermaid-js/mermaid-live-editor#run-published-image

catcatcatcat commented 2 years ago

Thank you for replying!