Update documents to compatible jekyll-rtd-theme
15
docs/assets/SUMMARY.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Summary
|
||||
|
||||
- [mermaid](README.md)
|
||||
- [FAQ](faq.md)
|
||||
- [Breaking changes](breakingChanges.md)
|
||||
- [Usage](usage.md)
|
||||
- [Flowchart](flowchart.md)
|
||||
- [Sequence diagram](sequenceDiagram.md)
|
||||
- [Gantt diagram](gantt.md)
|
||||
- [mermaid CLI](mermaidCLI.md)
|
||||
- [Demos](demos.md)
|
||||
- [mermaidAPI](mermaidAPI.md)
|
||||
- [Development](development.md)
|
||||
- [Upgrading](upgrading.md)
|
||||
- [Contribute to this website](https://github.com/mermaidjs/mermaid-gitbook)
|
13
docs/assets/_navbar.md
Normal file
@@ -0,0 +1,13 @@
|
||||
* Getting started
|
||||
|
||||
* [Quick start](quickstart.md)
|
||||
* [Writing more pages](more-pages.md)
|
||||
* [Custom navbar](custom-navbar.md)
|
||||
* [Cover page](cover.md)
|
||||
|
||||
* Configuration
|
||||
* [Configuration](configuration.md)
|
||||
* [Themes](themes.md)
|
||||
* [Using plugins](plugins.md)
|
||||
* [Markdown configuration](markdown.md)
|
||||
* [Language highlight](language-highlight.md)
|
38
docs/assets/_sidebar.md
Normal file
@@ -0,0 +1,38 @@
|
||||
- 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) -->
|
||||
|
||||
|
||||
- Tutorials and Community
|
||||
|
||||
<!-- - [Development and Contribution](development.md)
|
||||
- [Mermaid Versions](versionUpdates.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)
|
||||
- [Directives](directives.md) -->
|
51
docs/assets/breakingChanges.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Breaking changes
|
||||
**Edit this Page** [](https://github.com/mermaid-js/mermaid/blob/develop/docs/breakingChanges.md)
|
||||
### Breaking changes from history version to latest version:
|
||||
|
||||
## #1
|
||||
|
||||
```javascript
|
||||
mermaid.initialize({
|
||||
sequenceDiagram:{
|
||||
...
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
has been changed to
|
||||
|
||||
```javascript
|
||||
mermaid.initialize({
|
||||
sequence:{
|
||||
...
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## #2
|
||||
|
||||
In old versions you need to add CSS file to your HTML:
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="mermaid.min.css">
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="mermaid.forest.min.css">
|
||||
```
|
||||
|
||||
Now it is not needed to do so. And there are no more CSS files in distrubtion files.
|
||||
|
||||
You just
|
||||
|
||||
```javascript
|
||||
mermaid.initialize({
|
||||
theme: 'forest'
|
||||
})
|
||||
```
|
||||
|
||||
and it works like a charm.
|
||||
|
||||
This is because now the CSS is inline with SVG for portability.
|
30
docs/assets/developer-docs/configuration.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Configuration
|
||||
|
||||
When mermaid starts configuration is extracted to a configuration to be used for a diagram. There a 3 sources for configuration:
|
||||
|
||||
* The default configuration
|
||||
* Overrides on the site level, set is set by the initialize call and will be applied for all diagrams in the site/app. The term for this is the **siteConfig**.
|
||||
* Directives - diagram authors can update select configuration parameters directly int he diagram code via directives and these are applied to the render config.
|
||||
|
||||
**The render config** is configration that is used when rendering by applying these configurations.
|
||||
|
||||
## Theme configuration
|
||||
|
||||
## Starting mermaid
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
Site->>mermaid: initialize
|
||||
Site->>mermaid: content loaded
|
||||
mermaid->>mermaidAPI: init
|
||||
```
|
||||
|
||||
## Initialize
|
||||
|
||||
Intialize call is calloed **only once**. It is called by the site integrator in order to override the default configuration on a site level.
|
||||
|
||||
## configApi.reset
|
||||
|
||||
This method resets the configuration for a diagram to the site configuration, the configuration provided by the site integrator. Before each rendering of a diagram reset is called in the very beginning of render.
|
||||
|
||||
##
|
BIN
docs/assets/img/Gantt-excluded-days-within.png
Normal file
After Width: | Height: | Size: 78 KiB |
BIN
docs/assets/img/Gantt-long-weekend-look.png
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
docs/assets/img/GitHub-Mark-32px.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/assets/img/assignWithDepth.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/assets/img/class.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
docs/assets/img/er.png
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
docs/assets/img/flow.png
Normal file
After Width: | Height: | Size: 6.1 KiB |
BIN
docs/assets/img/gantt.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/assets/img/git.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/assets/img/header.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
docs/assets/img/liveEditorOptions.png
Normal file
After Width: | Height: | Size: 102 KiB |
BIN
docs/assets/img/n00b-Confluence1.png
Normal file
After Width: | Height: | Size: 71 KiB |
BIN
docs/assets/img/n00b-Confluence2.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/assets/img/n00b-Confluence3.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
docs/assets/img/n00b-Confluence4.png
Normal file
After Width: | Height: | Size: 31 KiB |
BIN
docs/assets/img/n00b-firstFlow.png
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
docs/assets/img/n00b-liveEditor.png
Normal file
After Width: | Height: | Size: 111 KiB |
BIN
docs/assets/img/new-diagrams.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
docs/assets/img/object.assign without depth.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/assets/img/sequence.png
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
docs/assets/img/simple-er.png
Normal file
After Width: | Height: | Size: 7.9 KiB |
BIN
docs/assets/img/user-journey.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/assets/img/without wrap.png
Normal file
After Width: | Height: | Size: 182 KiB |
BIN
docs/assets/img/wrapped text.png
Normal file
After Width: | Height: | Size: 109 KiB |
77
docs/assets/index.docsify.html
Normal file
@@ -0,0 +1,77 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>mermaid - Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||
<meta name="description" content="Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.">
|
||||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||||
<!-- <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css"> -->
|
||||
<link rel="stylesheet" href="theme.css"> <script src="//cdn.jsdelivr.net/npm/mermaid@8.7.0/dist/mermaid.min.js"></script>
|
||||
<!-- <script src="http://localhost:9000/mermaid.js"></script> -->
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-153180559-1', 'auto');
|
||||
if(location) {
|
||||
ga('send', 'pageview', location.hash);
|
||||
}
|
||||
|
||||
</script>
|
||||
|
||||
<style>
|
||||
.markdown-section {
|
||||
max-width: 1200px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
search: 'auto',
|
||||
name: 'mermaid',
|
||||
repo: 'https://github.com/knsv/mermaid',
|
||||
loadSidebar: true,
|
||||
mergeNavbar: true,
|
||||
maxLevel: 4,
|
||||
subMaxLevel: 2,
|
||||
markdown: {
|
||||
renderer: {
|
||||
code: function(code, lang) {
|
||||
if (lang === "mermaid") {
|
||||
return (
|
||||
'<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + "</div>"
|
||||
);
|
||||
}
|
||||
return this.origin.code.apply(this, arguments);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var num = 0;
|
||||
const isDarkMode = window.matchMedia("(prefers-color-scheme: dark)").matches
|
||||
|
||||
const conf = { logLevel:4, startOnLoad: false, themeCSS:'.label { font-family: Source Sans Pro,Helvetica Neue,Arial,sans-serif; }' };
|
||||
if(isDarkMode && false) conf.theme = 'dark';
|
||||
mermaid.initialize(conf);
|
||||
|
||||
</script>
|
||||
<script>
|
||||
window.onhashchange = function(a) {
|
||||
//code
|
||||
if(location) {
|
||||
ga('send', 'pageview', location.hash);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
||||
<scrpt src="//unpkg.com/docsify/lib/plugins/ga.min.js"></scrpt>
|
||||
</body>
|
||||
</html>
|
||||
<!-- -->
|
BIN
docs/assets/liveEditorOptions.png
Normal file
After Width: | Height: | Size: 102 KiB |
3
docs/assets/theme.css
Normal file
10
docs/assets/theme_themed.css
Normal file
28
docs/assets/upgrading.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Upgrading
|
||||
|
||||
Some of the interfaces has been upgraded.
|
||||
|
||||
|
||||
## From version 0.4.0 to 0.5.0
|
||||
|
||||
|
||||
### Initialization
|
||||
|
||||
`mermaid_config` is no longer used. Instead a call to mermaid initialize is done as in the example below:
|
||||
|
||||
|
||||
#### version 0.4.0
|
||||
|
||||
```javascript
|
||||
mermaid_config = {
|
||||
startOnLoad: true
|
||||
}
|
||||
```
|
||||
|
||||
#### version 0.5.0
|
||||
|
||||
```javascript
|
||||
mermaid.initialize({
|
||||
startOnLoad: true
|
||||
})
|
||||
```
|