mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-11-19 04:04:28 +01:00
Updated readme and changes to the coverage setting on the ci server
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- "0.10"
|
||||
addons:
|
||||
code_climate:
|
||||
repo_token: e87e6bf1c253e0555437ebd23235fdfe2749b889358e7c6d100e4ea5b4f2e091
|
||||
after_script:
|
||||
- cat coverage/lcov.info | codeclimate
|
||||
29
README.md
29
README.md
@@ -141,6 +141,21 @@ id1(This is the text in the box);
|
||||
|
||||

|
||||
|
||||
### A node in the form of a circle
|
||||
```
|
||||
id1((This is the text in the box));
|
||||
```
|
||||
|
||||

|
||||
|
||||
### A node in an asymetric shape
|
||||
```
|
||||
id1>This is the text in the box];
|
||||
```
|
||||
|
||||

|
||||
|
||||
|
||||
### A node (rhombus)
|
||||
```
|
||||
id1{This is the text in the box};
|
||||
@@ -218,5 +233,19 @@ A---|This is the text|B;
|
||||
|
||||

|
||||
|
||||
### Styling links
|
||||
It is possible to style links for instance a link that is going back in the flow. This is done by the linkStyle statement as in the example below:
|
||||
|
||||
```
|
||||
linkStyle 3 stroke:#ff3,stroke-width:4px;
|
||||
``
|
||||
|
||||
## Interaction
|
||||
|
||||
It is possible to bind a click event to a node: click nodeId callback.
|
||||
|
||||
* nodeId is the id of the node
|
||||
* callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the nodeId as parameter.
|
||||
|
||||
# Credits
|
||||
Many thanks to the [d3](http://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!!!
|
||||
|
||||
Reference in New Issue
Block a user