marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-20 15:59:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Re enable markdown & jsdoc linting.

Browse Source
This commit is contained in:
Sidharth Vinod
2022-06-22 01:13:25 +05:30
parent 06595cc4d4
commit 03446ce35c
4 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.eslintrc.json
View File

@@ -15,9 +15,9 @@
}, },
"extends": [ "extends": [
"eslint:recommended", "eslint:recommended",
//"plugin:jsdoc/recommended", "plugin:jsdoc/recommended",
"plugin:json/recommended", "plugin:json/recommended",
// "plugin:markdown/recommended", "plugin:markdown/recommended",
"plugin:prettier/recommended" "plugin:prettier/recommended"
], ],
"plugins": ["html", "jest", "jsdoc", "json", "prettier"], "plugins": ["html", "jest", "jsdoc", "json", "prettier"],

1
docs/development.md
View File

@@ -98,7 +98,6 @@ it('should render forks and joins', () => {
); );
cy.get('svg'); cy.get('svg');
}); });
``` ```
### Any Questions or Suggestions? ### Any Questions or Suggestions?

26
docs/newDiagram.md
View File

@@ -243,24 +243,26 @@ This function will in turn call a function *your diagram should provide* returni
```js ```js
const getStyles = (options) => const getStyles = (options) =>
` `
.line { .line {
stroke-width: 1; stroke-width: 1;
stroke: ${options.lineColor}; stroke: ${options.lineColor};
stroke-dasharray: 2; stroke-dasharray: 2;
} }
// ... // ...
`;
``` ```
Note that you need to provide your function to the main getStyles by adding it into the themes object in **src/styles.js** like in the xyzDiagram in the provided example: Note that you need to provide your function to the main getStyles by adding it into the themes object in **src/styles.js** like in the xyzDiagram in the provided example:
```js ```js
const themes = { const themes = {
flowchart, flowchart,
'flowchart-v2': flowchart, 'flowchart-v2': flowchart,
sequence, sequence,
xyzDiagram xyzDiagram,
//... //...
};
``` ```
The actual options and values for the colors are defined in **src/theme/theme-[xyz].js**. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups. The actual options and values for the colors are defined in **src/theme/theme-[xyz].js**. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups.

2
package.json
View File

@@ -27,7 +27,7 @@
"postbuild": "documentation build src/mermaidAPI.js src/config.js src/defaultConfig.js --shallow -f md --markdown-toc false > docs/Setup.md", "postbuild": "documentation build src/mermaidAPI.js src/config.js src/defaultConfig.js --shallow -f md --markdown-toc false > docs/Setup.md",
"build:watch": "yarn build:development --watch", "build:watch": "yarn build:development --watch",
"release": "yarn build", "release": "yarn build",
"lint": "eslint ./ --ext .js,.json,.html", "lint": "eslint ./ --ext .js,.json,.html,.md",
"lint:fix": "yarn lint --fix", "lint:fix": "yarn lint --fix",
"e2e:depr": "yarn lint && jest e2e --config e2e/jest.config.js", "e2e:depr": "yarn lint && jest e2e --config e2e/jest.config.js",
"cypress": "cypress run", "cypress": "cypress run",