Merge pull request #1746 from NeilCuzon/develop
Switching to Docsify and adding search
Neil Cuzon
GitHub
@ -1,7 +1,7 @@
|
||||
# mermaid [](https://travis-ci.org/mermaid-js/mermaid) [](https://www.npmjs.com/package/mermaid) [](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [](https://percy.io/Mermaid/mermaid)
|
||||
|
||||
|
||||
**Edit this Page** [](https://github.com/mermaid-js/mermaid/blob/develop/docs/README.md)
|
||||
**Edit this Page** [](https://github.com/mermaid-js/mermaid/blob/develop/docs/README.md)
|
||||
|
||||
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/2019) in the category "The most exciting use of technology"!!!**
|
||||
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
remote_theme: false
|
||||
|
||||
baseurl: /mermaid
|
||||
|
||||
theme: jekyll-rtd-theme
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 4
|
||||
title: Directives
|
||||
---
|
||||
|
||||
# Version 8.6.0 Changes
|
||||
|
||||
## [New Mermaid Live-Editor Beta](https://mermaid-js.github.io/docs/mermaid-live-editor-beta/#/edit/eyJjb2RlIjoiJSV7aW5pdDoge1widGhlbWVcIjogXCJmb3Jlc3RcIiwgXCJsb2dMZXZlbFwiOiAxIH19JSVcbmdyYXBoIFREXG4gIEFbQ2hyaXN0bWFzXSAtLT58R2V0IG1vbmV5fCBCKEdvIHNob3BwaW5nKVxuICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgQyAtLT58T25lfCBEW0xhcHRvcF1cbiAgQyAtLT58VHdvfCBFW2lQaG9uZV1cbiAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cblx0XHQiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGFyayJ9fQ)
|
||||
@ -107,7 +102,7 @@ It is a non-argument directive and can be executed thusly:
|
||||
|
||||
**an example of text wrapping in a sequence diagram**:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Resetting Configurations:
|
||||
@ -126,12 +121,12 @@ There are two more functions in the mermaidAPI that can be called by site owners
|
||||
|
||||
Example of **assignWithDepth**:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Example of **object.Assign**:
|
||||
|
||||
|
||||
|
||||
|
||||
• **calculateTextDimensions, calculateTextWidth,** and **calculateTextHeight** - for measuring text dimensions, width and height.
|
||||
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 3
|
||||
title: Changelog
|
||||
---
|
||||
|
||||
# Change Log
|
||||
|
||||
Here is the list of the newest versions in Descending Order, beginning from the latest version.
|
||||
@ -1,5 +0,0 @@
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "jekyll-rtd-theme"
|
||||
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
@ -1,14 +0,0 @@
|
||||
default:
|
||||
@gem install jekyll bundler && bundle install
|
||||
|
||||
update:
|
||||
@bundle update
|
||||
|
||||
clean:
|
||||
@bundle exec jekyll clean
|
||||
|
||||
build: clean
|
||||
@bundle exec jekyll build --profile --config _config.yml,.debug.yml
|
||||
|
||||
server: clean
|
||||
@bundle exec jekyll server --livereload --config _config.yml,.debug.yml
|
||||
@ -1,6 +1,6 @@
|
||||
# mermaid [](https://travis-ci.org/mermaid-js/mermaid) [](https://www.npmjs.com/package/mermaid) [](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [](https://percy.io/Mermaid/mermaid)
|
||||
|
||||
|
||||
|
||||
|
||||
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees) in the category "The most exciting use of technology"!!!**
|
||||
|
||||
@ -43,7 +43,7 @@ graph TD;
|
||||
C-->D;
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### [Sequence diagram](https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/sequenceDiagram.html)
|
||||
|
||||
@ -61,7 +61,7 @@ sequenceDiagram
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### [Gantt diagram](https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/gantt.html)
|
||||
|
||||
@ -78,7 +78,7 @@ Future task : des3, after des2, 5d
|
||||
Future task2 : des4, after des3, 5d
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### [Class diagram - :exclamation: experimental](https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/classDiagram.html)
|
||||
|
||||
@ -99,7 +99,7 @@ Class01 : int gorilla
|
||||
Class08 <--> C2: Cool label
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### Git graph - :exclamation: experimental
|
||||
|
||||
@ -122,7 +122,7 @@ commit
|
||||
merge newbranch
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
### [Entity Relationship Diagram - :exclamation: experimental](https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/entityRelationshipDiagram.html)
|
||||
|
||||
@ -134,7 +134,7 @@ erDiagram
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### [User Journey Diagram](https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/user-journey.html)
|
||||
|
||||
@ -149,7 +149,7 @@ journey
|
||||
Go downstairs: 5: Me
|
||||
Sit down: 5: Me
|
||||
```
|
||||
|
||||
|
||||
|
||||
# Installation
|
||||
## In depth guides and examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) and [Usage](getting-started/usage.md).
|
||||
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 3
|
||||
title: Configurations
|
||||
---
|
||||
|
||||
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
||||
|
||||
## mermaidAPI
|
||||
@ -1,37 +0,0 @@
|
||||
title: mermaid
|
||||
lang: en
|
||||
description: Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.
|
||||
|
||||
remote_theme: rundocs/jekyll-rtd-theme
|
||||
|
||||
mermaid:
|
||||
custom: https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js
|
||||
|
||||
copyright:
|
||||
since: 2014
|
||||
revision: true
|
||||
|
||||
edit: true
|
||||
addons_branch: true
|
||||
|
||||
google:
|
||||
gtag: UA-153180559-1
|
||||
|
||||
sass:
|
||||
style: compressed
|
||||
|
||||
addons:
|
||||
- github
|
||||
- i18n
|
||||
- analytics
|
||||
|
||||
plugins:
|
||||
- jemoji
|
||||
|
||||
readme_index:
|
||||
with_frontmatter: true
|
||||
|
||||
exclude:
|
||||
- Makefile
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
37
docs/_sidebar.md
Normal file
@ -0,0 +1,37 @@
|
||||
- Overview 📚
|
||||
- [mermaid](README.md)
|
||||
- [overview](n00b-overview.md)
|
||||
- [Use-Cases and Integrations](integrations.md)
|
||||
- [FAQ](faq.md)
|
||||
|
||||
- Getting Started✒️
|
||||
|
||||
- [Getting started - easier](n00b-gettingStarted.md)
|
||||
- [Tutorials](Tutorials.md)
|
||||
- [API-Usage](usage.md)
|
||||
- [Configurations](Setup.md)
|
||||
- [Directives](8.6.0_docs.md)
|
||||
- [Theming](theming.md)
|
||||
- [mermaid CLI](mermaidCLI.md)
|
||||
- [Advanced usage](n00b-advanced.md)
|
||||
|
||||
|
||||
- Contributions and Community 🙌
|
||||
|
||||
- [Development and Contribution ](development.md)
|
||||
- [Mermaid Versions](versionUpdates.md)
|
||||
- [Changelog](CHANGELOG.md)
|
||||
- [Adding Diagrams ](newDiagram.md)
|
||||
|
||||
- Diagrams and Syntax and Examples 📊
|
||||
|
||||
- [Diagram syntax intro](n00b-syntaxReference.md)
|
||||
- [Examples](examples.md)
|
||||
- [Flowchart](flowchart.md)
|
||||
- [Sequence diagram](sequenceDiagram.md)
|
||||
- [Class Diagram](classDiagram.md)
|
||||
- [State Diagram](stateDiagram.md)
|
||||
- [Entity Relationship Diagram](entityRelationshipDiagram.md)
|
||||
- [User Journey](user-journey.md)
|
||||
- [Gantt](gantt.md)
|
||||
- [Pie Chart](pie.md)
|
||||
@ -1,37 +0,0 @@
|
||||
- Overview
|
||||
- [mermaid](README.md)
|
||||
<!-- - [overview](n00b-overview.md) -->
|
||||
<!-- - [Use-Cases and Integrations](integrations.md) -->
|
||||
<!-- - [FAQ](faq.md) -->
|
||||
|
||||
- Getting Started
|
||||
|
||||
<!-- - [Getting started - easier](n00b-gettingStarted.md) -->
|
||||
<!-- - [Tutorials](Tutorials.md) -->
|
||||
<!-- - [API-Usage](usage.md) -->
|
||||
<!-- - [Configurations](Setup.md) -->
|
||||
<!-- - [Directives](8.6.0_docs.md) -->
|
||||
<!-- - [Theming](theming.md) -->
|
||||
<!-- - [mermaid CLI](mermaidCLI.md) -->
|
||||
<!-- - [Advanced usage](n00b-advanced.md) -->
|
||||
|
||||
|
||||
- Contributions and Community
|
||||
|
||||
<!-- - [Development and Contribution](development.md)-->
|
||||
<!-- - [Adding Diagrams](newDiagram.md)-->
|
||||
<!-- - [Changelog](CHANGELOG.md) -->
|
||||
|
||||
|
||||
- Diagrams and Syntax and Examples
|
||||
|
||||
<!-- - [Diagram syntax intro](n00b-syntaxReference.md) -->
|
||||
<!-- - [Examples](examples.md)
|
||||
- [Flowchart](flowchart.md) -->
|
||||
<!-- - [Sequence diagram](sequenceDiagram.md)
|
||||
- [Class Diagram](classDiagram.md)
|
||||
- [State Diagram](stateDiagram.md)
|
||||
- [Entity Relationship Diagram](entityRelationshipDiagram.md)
|
||||
- [User Journey](user-journey.md)
|
||||
- [Gantt](gantt.md)
|
||||
- [Pie Chart](pie.md)
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 5
|
||||
---
|
||||
|
||||
# Class diagrams
|
||||
|
||||
> "In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system's classes, their attributes, operations (or methods), and the relationships among objects."
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 1
|
||||
title: Development and Contribution
|
||||
---
|
||||
|
||||
# Development 🙌
|
||||
|
||||
|
||||
@ -12,7 +7,7 @@ So you want to help? That's great!
|
||||
|
||||
Here are a few things to know to get you started on the right path.
|
||||
|
||||
**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md)**
|
||||
**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)**
|
||||
|
||||
**Note: You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.**
|
||||
|
||||
@ -51,7 +46,7 @@ If it is not in the documentation, it's like it never happened. Wouldn't that be
|
||||
|
||||
The docs are located in the `docs` folder and are written in MarkDown. Just pick the right section and start typing. If you want to propose changes to the structure of the documentation:
|
||||
|
||||
**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them.**
|
||||
**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md). Click edit it to see them.**
|
||||
|
||||
The contents of [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch.
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
sort: 4
|
||||
---
|
||||
|
||||
# Diagrams and Syntax and Examples
|
||||
{% include list.liquid %}
|
||||
@ -1,8 +1,4 @@
|
||||
---
|
||||
sort: 10
|
||||
---
|
||||
|
||||
## Directives
|
||||
# Directives
|
||||
|
||||
## Directives were added in [Version 8.6.0](../getting-started/8.6.0_docs.md). Please Read it for more information.
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 7
|
||||
---
|
||||
|
||||
# Entity Relationship Diagrams
|
||||
|
||||
> An entity–relationship model (or ER model) describes interrelated things of interest in a specific domain of knowledge. A basic ER model is composed of entity types (which classify the things of interest) and specifies relationships that can exist between entities (instances of those entity types). Wikipedia.
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 2
|
||||
---
|
||||
|
||||
# Examples
|
||||
|
||||
This page contains a collection of examples of diagrams and charts that can be created through mermaid and its myriad applications.
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 3
|
||||
title: FAQ
|
||||
---
|
||||
|
||||
# Frequently Asked Questions
|
||||
|
||||
1. [How to add title to flowchart?](https://github.com/knsv/mermaid/issues/556#issuecomment-363182217)
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 3
|
||||
title: Flowchart
|
||||
---
|
||||
|
||||
# Flowcharts - Basic Syntax
|
||||
|
||||
## Graph
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 9
|
||||
title: Gantt
|
||||
---
|
||||
|
||||
# Gantt diagrams
|
||||
|
||||
> A Gantt chart is a type of bar chart, first developed by Karol Adamiecki in 1896, and independently by Henry Gantt in the 1910s, that illustrates a project schedule and the amount of time it would take for any one project to finish. Gantt charts illustrate number of days between the start and finish dates of the terminal elements and summary elements of a project.
|
||||
@ -12,11 +7,11 @@ title: Gantt
|
||||
|
||||
|
||||
It is important to remember that when a date, day, or collection of dates specific to a task are "excluded", the Gantt Chart will accomodate those changes by extending an equal number of day, towards the right, not by creating a gap inside the task.
|
||||
As shown here 
|
||||
As shown here 
|
||||
|
||||
|
||||
However, if the excluded dates are between two tasks that are set to start consecutively, the excluded dates will be skipped graphically and left blank, and the following task will begin after the end of the excluded dates.
|
||||
As shown here 
|
||||
As shown here 
|
||||
|
||||
A Gantt chart is useful for tracking the amount of time it would take before a project is finished, but it can also be used to graphically represent "non-working days", with a few tweaks.
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
sort: 2
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
{% include list.liquid %}
|
||||
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 7.9 KiB After Width: | Height: | Size: 7.9 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 182 KiB After Width: | Height: | Size: 182 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
@ -75,3 +75,5 @@
|
||||
</body>
|
||||
</html>
|
||||
<!-- -->
|
||||
|
||||
</html>
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 2
|
||||
title: Use-Cases and Integrations
|
||||
---
|
||||
|
||||
# Integrations
|
||||
|
||||
The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions
|
||||
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 6
|
||||
---
|
||||
|
||||
# mermaid CLI
|
||||
|
||||
mermaid CLI has been moved to [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). Please read its documentation instead.
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 7
|
||||
title: Advanced usage
|
||||
---
|
||||
|
||||
# Advanced n00b mermaid (Coming soon..)
|
||||
|
||||
## splitting mermaid code from html
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 1
|
||||
title: Getting started - easier
|
||||
---
|
||||
|
||||
# A basic mermaid User-Guide for Beginners
|
||||
|
||||
Creating diagrams and charts using mermaid code is simple.
|
||||
@ -31,15 +26,15 @@ In the `Code` section one can write or edit raw mermaid code, and instantly `Pre
|
||||
|
||||
**This is a great way to learn how to define a mermaid diagram.**
|
||||
|
||||
For some popular video tutorials on the live editor go to [Overview](../overview/n00b-overview.md).
|
||||
For some popular video tutorials on the live editor go to [Overview](/overview/n00b-overview.md).
|
||||
|
||||
|
||||
|
||||
|
||||
**Notes:**
|
||||
|
||||
You can also click "Copy Markdown" to copy the markdown code for the diagram, that can then be pasted directly into your documentation.
|
||||
|
||||
|
||||
|
||||
|
||||
The `Mermaid configuration` is for controlling mermaid behaviour. An easy introduction to mermaid configuration is found in the [Advanced usage](n00b-advanced.md) section. A complete configuration reference cataloguing default values is found on the [mermaidAPI](Setup.md) page.
|
||||
|
||||
@ -57,25 +52,25 @@ When the mermaid plugin is installed on a Confluence server, one can insert a me
|
||||
|
||||
- In a Confluence page, Add Other macros.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
- Search for mermaid.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
- The mermaid object appears. Paste your mermaid code into it.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
- Save the page and the diagram appears.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
## The following are two ways of hosting mermaid on a webpage.
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 1
|
||||
title: Overview
|
||||
---
|
||||
|
||||
# Overview for Beginners
|
||||
|
||||
## Explaining with a Diagram
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 1
|
||||
title: Diagram syntax intro
|
||||
---
|
||||
|
||||
## Diagram syntax
|
||||
|
||||
If you are new to mermaid, read the [Getting Started](../getting-started/n00b-gettingStarted.md) and [Overview](../overview/n00b-overview.md) sections, to learn the basics of mermaid.
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 2
|
||||
title: Adding a New Diagram/Chart
|
||||
---
|
||||
|
||||
# Adding a New Diagram/Chart 📊
|
||||
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
---
|
||||
sort: 1
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
{% include list.liquid %}
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 10
|
||||
title: Pie Chart
|
||||
---
|
||||
|
||||
# Pie chart diagrams
|
||||
|
||||
> A pie chart (or a circle chart) is a circular statistical graphic, which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area), is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. The earliest known pie chart is generally credited to William Playfair's Statistical Breviary of 1801
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 4
|
||||
---
|
||||
|
||||
# Sequence diagrams
|
||||
|
||||
> A Sequence diagram is an interaction diagram that shows how processes operate with one another and in what order.
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 6
|
||||
---
|
||||
|
||||
# State diagrams
|
||||
|
||||
> "A state diagram is a type of diagram used in computer science and related fields to describe the behavior of systems. State diagrams require that the system described is composed of a finite number of states; sometimes, this is indeed the case, while at other times this is a reasonable abstraction." Wikipedia
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 5
|
||||
title: Theming
|
||||
---
|
||||
|
||||
# Version 8.7.0: Theme Configuration
|
||||
|
||||
With Version 8.7.0 Mermaid comes out with a system for dynamic and integrated configuration of the diagram themes. The objective of this is to increase the customizability of mermaid and the ease of Styling, with the customization of themes through the `%%init%%` directive and `initialize` calls.
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
sort: 3
|
||||
---
|
||||
|
||||
# Contributions and Community
|
||||
{% include list.liquid %}
|
||||
@ -1,8 +1,3 @@
|
||||
---
|
||||
sort: 2
|
||||
title: API-Usage
|
||||
---
|
||||
|
||||
# Usage
|
||||
|
||||
mermaid is a javascript tool that makes use of a markdown based syntax to render customizable diagrams and charts, for greater speed and ease.
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
sort: 8
|
||||
---
|
||||
|
||||
# User Journey Diagram
|
||||
|
||||
> User journeys describe at a high level of detail exactly what steps different users take to complete a specific task within a system, application or website. This technique shows the current (as-is) user workflow, and reveals areas of improvement for the to-be workflow. (Wikipedia)
|
||||