Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited n00b-GettingStarted.md and smaller edits to README.md and n00b-overview.md #1270

Merged
merged 28 commits into from
Feb 27, 2020
Merged
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
cd8b7e5
Update README.md
NeilCuzon Feb 22, 2020
8729414
Merge pull request #1 from NeilCuzon/NeilCuzon-patch-1
NeilCuzon Feb 22, 2020
17f99ae
Updated n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
d637a13
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
7aab34b
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
2d0edb5
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
702abba
Add files via upload
NeilCuzon Feb 23, 2020
a52d501
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
58374ad
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
d02a577
Add files via upload
NeilCuzon Feb 23, 2020
eafabdc
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
13261c9
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
8456905
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
72ac408
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
553b964
Update n00b-gettingStarted.md
NeilCuzon Feb 23, 2020
9607c74
Updated noob-gettingStarted.md
NeilCuzon Feb 23, 2020
e8a3ffc
Merge pull request #2 from NeilCuzon/NeilCuzon-patch-2
NeilCuzon Feb 23, 2020
7a44e46
Update n00b-overview.md
NeilCuzon Feb 24, 2020
a26fe71
Update README.md
NeilCuzon Feb 24, 2020
a4e488a
Suggestion from comment
erelling Feb 26, 2020
92fbc26
Suggestion in comment
erelling Feb 26, 2020
26c4366
Suggestion in comment
erelling Feb 26, 2020
33ea1d4
Merge branch 'develop' into develop
NeilCuzon Feb 27, 2020
5103da0
Update README.md
NeilCuzon Feb 27, 2020
065a5d2
Update n00b-overview.md
NeilCuzon Feb 27, 2020
4e044d6
Update n00b-gettingStarted.md
NeilCuzon Feb 27, 2020
3aa368b
Update n00b-gettingStarted.md
NeilCuzon Feb 27, 2020
67473f0
Update n00b-gettingStarted.md
NeilCuzon Feb 27, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated noob-gettingStarted.md
updated documentation for noob-gettingStarted.md. 
-added a new screenshot and edited directions for copying markdown code from live editor
-made some alterations with the instructions in effort to make it more n00b friendly.
-added link to Atom-mermaid plugin
  • Loading branch information
NeilCuzon authored Feb 23, 2020
commit 9607c743a03a5bf4e6e7fa42d7451fc576e44352
5 changes: 2 additions & 3 deletions docs/n00b-gettingStarted.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# A basic User-Guide for Beginners
# A basic mermaid User-Guide for Beginners

Creating diagrams and charts, using mermaid code is simple.

Expand All @@ -11,7 +11,7 @@ Most widely used web browsers, such as Firefox, Chrome and Safari, can render me
# For beginners, there are three relatively easy ways you can use mermaid:
1. Using the mermaid [live editor](https://mermaid-js.github.io/mermaid-live-editor/)
2. Using a mermaid plugin, such as that for Confluence or [Atom](https://atom.io/packages/atom-mermaid).
3. Calling mermaid with HTML, deployed in a friendly browser.
3. Calling mermaid renderer with HTML, deployed in a friendly browser.

# Following either of these examples, you can get started with creating your own diagrams using mermaid code.

Expand Down Expand Up @@ -91,7 +91,6 @@ c. The `mermaid.initialize()` command to start the rendering process.
This is what needs to go into the html file:



# a. The reference to the mermaid renderer has to be contained in a `<script src>` tag like so:

```
Expand Down