From a0dafb4093f012ae627c4beaa40e58fcf539977a Mon Sep 17 00:00:00 2001 From: sifb Date: Thu, 24 Nov 2016 21:26:07 +0000 Subject: [PATCH] Clarify the need for a CSS stylesheet Issue #273 says "the need for mermaid.css should be mentioned explicitly in the intro docs" - I ran into this problem as well, because I read `mermaid.min.js This bundle contains everything you need to run mermaid` very literally, but it doesn't contain everything and it needs a stylesheet as well. This edit tries to make that more clear. --- docs/content/usage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/usage.md b/docs/content/usage.md index c11845c2f6..e7528042ba 100644 --- a/docs/content/usage.md +++ b/docs/content/usage.md @@ -15,7 +15,7 @@ bower install mermaid --save-dev npm install mermaid --save-dev ``` -Or download css and javascript files as per the url below, note that #version# should be replaced with version of choice: +Or download a javascript bundle and a stylesheet, e.g. the urls below are for the default style and the all-in-one javascript - note that #version# should be replaced with version of choice: ``` https://cdn.rawgit.com/knsv/mermaid/#version#/dist/mermaid.css @@ -28,7 +28,7 @@ Ex: Checkout the [latest version](https://github.com/knsv/mermaid/releases) and [other styles](https://github.com/knsv/mermaid/tree/master/dist) such as `forest` and `dark`. There are some bundles to choose from: -* mermaid.js, mermaid.min.js This bundle contains everything you need to run mermaid +* mermaid.js, mermaid.min.js This bundle contains all the javascript libraries you need to run mermaid * mermaid.slim.js, mermaid.slim.min.js This bundle does not contain d3 which is useful for sites that already have d3 in place * mermaidAPI.js, mermaidAPI.min.js, This bundle does not contain the web integration provided in the other packages but has a render function instead returns svg code.