More code fence syntax highlighting
This commit is contained in:
parent
ab3e076c91
commit
dac542682d
|
@ -35,13 +35,13 @@ The documentation is written in Markdown, for more information about Markdown [s
|
|||
|
||||
If you want to preview the documentation site on your machine, you need to install `docsify-cli`:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ npm i docsify-cli -g
|
||||
````
|
||||
```
|
||||
|
||||
If you are more familiar with Yarn, you can use the following command:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ yarn global add docsify-cli
|
||||
```
|
||||
|
||||
|
@ -50,7 +50,7 @@ If the installation is successful, the command `docsify` will be available in yo
|
|||
|
||||
You can now run the following command to serve the documentation site:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ docsify serve docs
|
||||
```
|
||||
|
||||
|
@ -85,7 +85,7 @@ The rendering tests are very straightforward to create. There is a function imgS
|
|||
When running in ci it will take a snapshot of the rendered diagram and compare it with the snapshot from last build and flag for review it if it differs.
|
||||
|
||||
This is what a rendering test looks like:
|
||||
```
|
||||
```javascript
|
||||
it('should render forks and joins', () => {
|
||||
imgSnapshotTest(
|
||||
`
|
||||
|
|
|
@ -24,7 +24,7 @@ Site-wide themes are still declared via `initialize` by site owners.
|
|||
|
||||
Example of `Initalize` call setting `theme` to `base`:
|
||||
|
||||
```js
|
||||
```javascript
|
||||
mermaidAPI.initialize({
|
||||
'securityLevel': 'loose', 'theme': 'base'
|
||||
});
|
||||
|
|
|
@ -1090,7 +1090,7 @@ Note: modifies options in-place
|
|||
|
||||
Function that renders an svg with a graph from a chart definition. Usage example below.
|
||||
|
||||
```js
|
||||
```javascript
|
||||
mermaidAPI.initialize({
|
||||
startOnLoad:true
|
||||
});
|
||||
|
|
|
@ -78,7 +78,7 @@ When running in CI it will take a snapshot of the rendered diagram and compare i
|
|||
|
||||
This is what a rendering test looks like:
|
||||
|
||||
```
|
||||
```js
|
||||
it('should render forks and joins', () => {
|
||||
imgSnapshotTest(
|
||||
`
|
||||
|
|
|
@ -17,7 +17,7 @@ For instance:
|
|||
|
||||
There are some jison specific sub steps here where the parser stores the data encountered when parsing the diagram, this data is later used by the renderer. You can during the parsing call a object provided to the parser by the user of the parser. This object can be called during parsing for storing data.
|
||||
|
||||
```
|
||||
```jison
|
||||
statement
|
||||
: 'participant' actor { $$='actor'; }
|
||||
| signal { $$='signal'; }
|
||||
|
|
|
@ -12,7 +12,7 @@ Themes follow and build upon the Levels of Configuration and employ `directives`
|
|||
Site-wide themes are still declared via `initialize` by site owners.
|
||||
|
||||
Example of `Initalize` call setting `theme` to `base`:
|
||||
```js
|
||||
```javascript
|
||||
mermaidAPI.initialize({
|
||||
'securityLevel': 'loose', 'theme': 'base'
|
||||
});
|
||||
|
|
|
@ -269,7 +269,7 @@ renderer.code = function (code, language) {
|
|||
|
||||
Another example in coffeescript that also includes the mermaid script tag in the generated markup.
|
||||
|
||||
```js
|
||||
```coffee
|
||||
marked = require 'marked'
|
||||
|
||||
module.exports = (options) ->
|
||||
|
@ -370,7 +370,7 @@ approach are:
|
|||
* mermaid.startOnLoad
|
||||
* mermaid.htmlLabels
|
||||
|
||||
```js
|
||||
```javascript
|
||||
mermaid.startOnLoad = true;
|
||||
```
|
||||
|
||||
|
@ -401,7 +401,7 @@ To set some configuration via the mermaid object. The two parameters that are su
|
|||
* mermaid_config.startOnLoad
|
||||
* mermaid_config.htmlLabels
|
||||
|
||||
```js
|
||||
```javascript
|
||||
mermaid_config.startOnLoad = true;
|
||||
```
|
||||
|
||||
|
|
|
@ -200,7 +200,7 @@ export const decodeEntities = function (text) {
|
|||
/**
|
||||
* Function that renders an svg with a graph from a chart definition. Usage example below.
|
||||
*
|
||||
* ```js
|
||||
* ```javascript
|
||||
* mermaidAPI.initialize({
|
||||
* startOnLoad:true
|
||||
* });
|
||||
|
|
Loading…
Reference in New Issue