Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add '..auto generated..' to .html documentation files #3420

Conversation

weedySeaDragon
Copy link
Contributor

@weedySeaDragon weedySeaDragon commented Sep 6, 2022

📑 Summary

There are .html files in src/docs in addition to the markdown files. When they are copied to the docs directory, these should also have a comment in them saying that they were automatically generated so that people don't edit them.

  • added logic to docs.mts so that it now also transforms **/*.html files in addition to the **/*.md files.
    • The only transformation that happens to .html file is that a comment is inserted after the <html> tag saying that the file is autogenerated.

Other minor changes:

  • made the messages logged to console more detailed
  • eslint changed single quotes to double quotes. I'm not sure if this is wanted (the accepted style for this project) or not
  • added documentation blocks with JSDOC tags

Resolves #3418

📏 Design Decisions

If we need to do additional processing/transformations, it should be straightforward.

📋 Tasks

Make sure you

Copy link
Member

@sidharthv96 sidharthv96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This definitely kicks the quality of the file up a notch!
Awesome work @weedySeaDragon !

Just a few minor nits.

src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
@sidharthv96
Copy link
Member

If you sync develop and run docs:build and lint:fix, might fix the CI issue.

@weedySeaDragon
Copy link
Contributor Author

@sidharthv96 I'm not sure why this is failing the lint check.
I've verified that all of these files are the same as the mermaid/develop branch:

/docs/index.html
/docs/landing/index.html
.eslintrc.json
.prettierrc.json

And both eslint and prettier checks pass on my local system.

src/docs.mts Outdated Show resolved Hide resolved
src/docs.mts Outdated Show resolved Hide resolved
@sidharthv96
Copy link
Member

@weedySeaDragon the transformed HTML code was not being formatted with prettier.
Have fixed it.

@weedySeaDragon
Copy link
Contributor Author

aha. Makes sense.
Thanks for fixing it!

@weedySeaDragon
Copy link
Contributor Author

@sidharthv96 I merged the /develop branch but now linting is failing with lots of errors. I can see that you've changed the .eslintrc.json settings with #3393 ch. Perhaps updating the files to pass the stricter linting rules is still in progress on the develop branch?

Not sure what the right workflow is. Should I go ahead and push my commits up here, even tho the CI checks will fail?

@sidharthv96
Copy link
Member

I had fixed all lint errors in develop yesterday. So once you merge, the only change should be in docs.mts.

Did you run yarn install after merging develop? Can you please share what the errors are?

@weedySeaDragon
Copy link
Contributor Author

OK - looking at the output today with less tired eyes, I see that eslint shows a lot of warnings and zero errors. [facepalm]

@sidharthv96
Copy link
Member

@weedySeaDragon let's resolve the pending comment and get this in quick :)

@sidharthv96 sidharthv96 merged commit 8b53444 into mermaid-js:develop Sep 12, 2022
fuxingloh referenced this pull request in fuxingloh/contented Nov 10, 2022
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`9.1.7` ->
`9.2.2`](https://renovatebot.com/diffs/npm/mermaid/9.1.7/9.2.2) |
[![age](https://badges.renovateapi.com/packages/npm/mermaid/9.2.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/mermaid/9.2.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/mermaid/9.2.2/compatibility-slim/9.1.7)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/mermaid/9.2.2/confidence-slim/9.1.7)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid</summary>

###
[`v9.2.2`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.2.2):
9.2.2

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v9.2.1...v9.2.2)

#### What's Changed

- \[9.2] fix(mermaid): fix `mermaid.render` types by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3768](https://togithub.com/mermaid-js/mermaid/pull/3768)
- \[9.2] fix(mermaid): default mermaid back to CommonJS by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3767](https://togithub.com/mermaid-js/mermaid/pull/3767)
- Fix lazy loading in webpack by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3774](https://togithub.com/mermaid-js/mermaid/pull/3774)

**Full Changelog**:
mermaid-js/mermaid@v9.2.1...v9.2.2

###
[`v9.2.1`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.2.1):
9.2.1

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v9.2.0...v9.2.1)

#### What's Changed

- \~~fix
[#&#8203;3757](https://togithub.com/mermaid-js/mermaid/issues/3757) :
Remove dynamic imports for lazy load causing issues for webpack~~
- chore: Update bug report template by
[@&#8203;gibson042](https://togithub.com/gibson042) in
[https://github.com/mermaid-js/mermaid/pull/3727](https://togithub.com/mermaid-js/mermaid/pull/3727)
- Use issue templates and add diagram, theme and syntax proposal issue
forms by [@&#8203;Andre601](https://togithub.com/Andre601) in
[https://github.com/mermaid-js/mermaid/pull/2739](https://togithub.com/mermaid-js/mermaid/pull/2739)

#### New Contributors

- [@&#8203;Andre601](https://togithub.com/Andre601) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/2739](https://togithub.com/mermaid-js/mermaid/pull/2739)

**Full Changelog**:
mermaid-js/mermaid@v9.2.0...v9.2.1

###
[`v9.2.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.2.0):
9.2.0

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v9.1.7...v9.2.0)

#### What's Changed

##### Features

- Mindmaps by [@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/3410](https://togithub.com/mermaid-js/mermaid/pull/3410)
- Introducing TypeScript by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3336](https://togithub.com/mermaid-js/mermaid/pull/3336)
- Auto transform `mermaid-example` in docs. by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3401](https://togithub.com/mermaid-js/mermaid/pull/3401)
- Creating detectors and moving out diagram specific code from the diag…
by [@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/3436](https://togithub.com/mermaid-js/mermaid/pull/3436)
- feat(git): cherry-pick keyword supports tag attribute by
[@&#8203;elliot-nelson](https://togithub.com/elliot-nelson) in
[https://github.com/mermaid-js/mermaid/pull/3479](https://togithub.com/mermaid-js/mermaid/pull/3479)
- Mindmaps replacing rendering algoritm with cose-bilkent by
[@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/3559](https://togithub.com/mermaid-js/mermaid/pull/3559)
- 3561 theme color scales by [@&#8203;knsv](https://togithub.com/knsv)
in
[https://github.com/mermaid-js/mermaid/pull/3562](https://togithub.com/mermaid-js/mermaid/pull/3562)
- ESBuild by [@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3386](https://togithub.com/mermaid-js/mermaid/pull/3386)
- (Beta) Lazy load import by [@&#8203;knsv](https://togithub.com/knsv)
in
[https://github.com/mermaid-js/mermaid/pull/3592](https://togithub.com/mermaid-js/mermaid/pull/3592),
[https://github.com/mermaid-js/mermaid/pull/3598](https://togithub.com/mermaid-js/mermaid/pull/3598)
- 3061 making a monorepo by [@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/3531](https://togithub.com/mermaid-js/mermaid/pull/3531)

##### Fixes

- Feature decimal duration in second for gantt diagram by
[@&#8203;vallsv](https://togithub.com/vallsv) in
[https://github.com/mermaid-js/mermaid/pull/3360](https://togithub.com/mermaid-js/mermaid/pull/3360)
- fix: fix passing a single Node to mermaid.init() by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3396](https://togithub.com/mermaid-js/mermaid/pull/3396)
- fix
[#&#8203;3407](https://togithub.com/mermaid-js/mermaid/issues/3407)
Replace `div` with `pre` and format by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3408](https://togithub.com/mermaid-js/mermaid/pull/3408)
- fix(git): support numeric branch names by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3392](https://togithub.com/mermaid-js/mermaid/pull/3392)
- Add tests for C4 system context macros by
[@&#8203;dbartholomae](https://togithub.com/dbartholomae) in
[https://github.com/mermaid-js/mermaid/pull/3367](https://togithub.com/mermaid-js/mermaid/pull/3367)
- Add nested test for parseGenericTypes by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3354](https://togithub.com/mermaid-js/mermaid/pull/3354)
- Fix memoize by [@&#8203;sidharthv96](https://togithub.com/sidharthv96)
in
[https://github.com/mermaid-js/mermaid/pull/3434](https://togithub.com/mermaid-js/mermaid/pull/3434)
- fix(git): support single character branch names by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3464](https://togithub.com/mermaid-js/mermaid/pull/3464)
- Replace GoogleAnalytics with Plausible by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3466](https://togithub.com/mermaid-js/mermaid/pull/3466)
- Fix for issues in errorhandling and class diagrams after refactoring
by [@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/3470](https://togithub.com/mermaid-js/mermaid/pull/3470)
- 3409 Fix for truncated tags in GitGraph by
[@&#8203;ashishjain0512](https://togithub.com/ashishjain0512) in
[https://github.com/mermaid-js/mermaid/pull/3454](https://togithub.com/mermaid-js/mermaid/pull/3454)
- Fix broken cherry-pick parsing in gitgraph by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3480](https://togithub.com/mermaid-js/mermaid/pull/3480)
- Fix CI `docs:lint` by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3493](https://togithub.com/mermaid-js/mermaid/pull/3493)
- Fix user-journey leaking css by
[@&#8203;lishid](https://togithub.com/lishid) in
[https://github.com/mermaid-js/mermaid/pull/3510](https://togithub.com/mermaid-js/mermaid/pull/3510)
- \[sequenceDiagrams] Support dashes in participant names by
[@&#8203;ashleybartlett](https://togithub.com/ashleybartlett) in
[https://github.com/mermaid-js/mermaid/pull/3524](https://togithub.com/mermaid-js/mermaid/pull/3524)
- fix: ER dark theme attribute colors by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3512](https://togithub.com/mermaid-js/mermaid/pull/3512)
- feat: ER diagram: allow other chars in a quoted entity name by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3516](https://togithub.com/mermaid-js/mermaid/pull/3516)
- Arrow tip aligned to edge of box by
[@&#8203;pbrolin47](https://togithub.com/pbrolin47) in
[https://github.com/mermaid-js/mermaid/pull/3533](https://togithub.com/mermaid-js/mermaid/pull/3533)
- Fixed labelText undefined behavior by
[@&#8203;AndrewL-64](https://togithub.com/AndrewL-64) in
[https://github.com/mermaid-js/mermaid/pull/3544](https://togithub.com/mermaid-js/mermaid/pull/3544)
- Fix failing vitest unit tests by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3587](https://togithub.com/mermaid-js/mermaid/pull/3587)
- fix: Import diagram by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3589](https://togithub.com/mermaid-js/mermaid/pull/3589)
- Fix file name during "pnpm run dev" script by
[@&#8203;vallsv](https://togithub.com/vallsv) in
[https://github.com/mermaid-js/mermaid/pull/3608](https://togithub.com/mermaid-js/mermaid/pull/3608)
- fix Detect diagram fallback by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3591](https://togithub.com/mermaid-js/mermaid/pull/3591)
- fix: Dirty fix for sync render. by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3633](https://togithub.com/mermaid-js/mermaid/pull/3633)
- fix: Converts mindmapDB to TS by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3683](https://togithub.com/mermaid-js/mermaid/pull/3683)
- Support `lazyLoadedDiagrams` when calling `initThrowsErrors` by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3702](https://togithub.com/mermaid-js/mermaid/pull/3702)
- \[9.2.0] Support `lazyLoadedDiagrams` when calling
`initThrowsErrorsAsync` by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3731](https://togithub.com/mermaid-js/mermaid/pull/3731)

##### Chores

- build: run `build:prod` on `yarn prepare` by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3404](https://togithub.com/mermaid-js/mermaid/pull/3404)
- chore(deps-dev): bump
[@&#8203;types/dompurify](https://togithub.com/types/dompurify) from
2.3.3 to 2.3.4 by [@&#8203;dependabot](https://togithub.com/dependabot)
in
[https://github.com/mermaid-js/mermaid/pull/3414](https://togithub.com/mermaid-js/mermaid/pull/3414)
- chore(deps-dev): bump jest-environment-jsdom from 29.0.1 to 29.0.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3413](https://togithub.com/mermaid-js/mermaid/pull/3413)
- chore(deps-dev): bump typescript from 4.7.4 to 4.8.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3411](https://togithub.com/mermaid-js/mermaid/pull/3411)
- chore(deps-dev): bump babel-jest from 29.0.1 to 29.0.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3412](https://togithub.com/mermaid-js/mermaid/pull/3412)
- chore: fix JSDOC [@&#8203;param](https://togithub.com/param),
[@&#8203;returns](https://togithub.com/returns) lint errors by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3422](https://togithub.com/mermaid-js/mermaid/pull/3422)
- style: forbid using `console` in mermaid src code by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3405](https://togithub.com/mermaid-js/mermaid/pull/3405)
- Introduce stricter typescript linting by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3393](https://togithub.com/mermaid-js/mermaid/pull/3393)
- Esbuild: backwards-compatible `mermaid.core.mjs` by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3437](https://togithub.com/mermaid-js/mermaid/pull/3437)
- fix(git): support unusual prefixes in branch name by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3438](https://togithub.com/mermaid-js/mermaid/pull/3438)
- Re-enable coverage upload to coveralls by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3431](https://togithub.com/mermaid-js/mermaid/pull/3431)
- chore(deps): bump actions/checkout from 2 to 3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3449](https://togithub.com/mermaid-js/mermaid/pull/3449)
- chore(deps-dev): bump typescript from 4.8.2 to 4.8.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3446](https://togithub.com/mermaid-js/mermaid/pull/3446)
- chore(deps-dev): bump eslint from 8.23.0 to 8.23.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3440](https://togithub.com/mermaid-js/mermaid/pull/3440)
- chore(deps-dev): bump babel-jest from 29.0.2 to 29.0.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3448](https://togithub.com/mermaid-js/mermaid/pull/3448)
- chore(deps-dev): bump jest-environment-jsdom from 29.0.2 to 29.0.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3441](https://togithub.com/mermaid-js/mermaid/pull/3441)
- chore(deps-dev): bump
[@&#8203;babel/core](https://togithub.com/babel/core) from 7.18.13 to
7.19.0 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3447](https://togithub.com/mermaid-js/mermaid/pull/3447)
- chore(deps-dev): bump
[@&#8203;typescript-eslint/parser](https://togithub.com/typescript-eslint/parser)
from 5.36.1 to 5.37.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3451](https://togithub.com/mermaid-js/mermaid/pull/3451)
- chore(deps-dev): bump
[@&#8203;babel/preset-env](https://togithub.com/babel/preset-env) from
7.18.10 to 7.19.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3442](https://togithub.com/mermaid-js/mermaid/pull/3442)
- chore(deps-dev): bump concurrently from 7.3.0 to 7.4.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3445](https://togithub.com/mermaid-js/mermaid/pull/3445)
- chore(deps-dev): bump
[@&#8203;typescript-eslint/eslint-plugin](https://togithub.com/typescript-eslint/eslint-plugin)
from 5.36.1 to 5.37.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3457](https://togithub.com/mermaid-js/mermaid/pull/3457)
- chore(deps-dev): bump eslint-plugin-jest from 27.0.1 to 27.0.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3458](https://togithub.com/mermaid-js/mermaid/pull/3458)
- Cleanup & fix eslint warnings by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3453](https://togithub.com/mermaid-js/mermaid/pull/3453)
- chore(deps-dev): bump webpack-dev-server from 4.10.1 to 4.11.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3450](https://togithub.com/mermaid-js/mermaid/pull/3450)
- chore(deps): bump stylis from 4.1.1 to 4.1.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3439](https://togithub.com/mermaid-js/mermaid/pull/3439)
- chore(deps): bump dompurify from 2.3.10 to 2.4.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3444](https://togithub.com/mermaid-js/mermaid/pull/3444)
- chore(deps-dev): bump
[@&#8203;types/lodash](https://togithub.com/types/lodash) from 4.14.184
to 4.14.185 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3489](https://togithub.com/mermaid-js/mermaid/pull/3489)
- chore(deps-dev): bump esbuild from 0.15.6 to 0.15.8 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3490](https://togithub.com/mermaid-js/mermaid/pull/3490)
- chore(deps-dev): bump eslint from 8.23.1 to 8.24.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3521](https://togithub.com/mermaid-js/mermaid/pull/3521)
- chore(deps-dev): bump
[@&#8203;types/prettier](https://togithub.com/types/prettier) from 2.7.0
to 2.7.1 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3520](https://togithub.com/mermaid-js/mermaid/pull/3520)
- chore: fix demo chart pages by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3523](https://togithub.com/mermaid-js/mermaid/pull/3523)
- Vitest by [@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3427](https://togithub.com/mermaid-js/mermaid/pull/3427)
- Build mermaid using Vite by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3503](https://togithub.com/mermaid-js/mermaid/pull/3503)
- Add "Debug Current Test File" configuration for VSCode by
[@&#8203;pje](https://togithub.com/pje) in
[https://github.com/mermaid-js/mermaid/pull/3509](https://togithub.com/mermaid-js/mermaid/pull/3509)
- \[DevOps] Parallel E2E by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3498](https://togithub.com/mermaid-js/mermaid/pull/3498)
- chore(deps-dev): update lint-staged requirement from ^13.0.0 to
^13.0.3 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3551](https://togithub.com/mermaid-js/mermaid/pull/3551)
- chore(deps-dev): update start-server-and-test requirement from ^1.12.6
to ^1.14.0 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3553](https://togithub.com/mermaid-js/mermaid/pull/3553)
- chore(deps-dev): update jsdom requirement from ^20.0.0 to ^20.0.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3552](https://togithub.com/mermaid-js/mermaid/pull/3552)
- chore(deps-dev): update
[@&#8203;types/express](https://togithub.com/types/express) requirement
from ^4.17.13 to ^4.17.14 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3555](https://togithub.com/mermaid-js/mermaid/pull/3555)
- chore(deps-dev): update
[@&#8203;types/lodash](https://togithub.com/types/lodash) requirement
from ^4.14.185 to ^4.14.186 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3556](https://togithub.com/mermaid-js/mermaid/pull/3556)
- chore(deps-dev): update vitest requirement from ^0.23.1 to ^0.23.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3557](https://togithub.com/mermaid-js/mermaid/pull/3557)
- chore(deps-dev): update husky requirement from ^8.0.0 to ^8.0.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3558](https://togithub.com/mermaid-js/mermaid/pull/3558)
- chore(deps-dev): update
[@&#8203;typescript-eslint/parser](https://togithub.com/typescript-eslint/parser)
requirement from ^5.37.0 to ^5.39.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3564](https://togithub.com/mermaid-js/mermaid/pull/3564)
- chore(deps-dev): update
[@&#8203;typescript-eslint/eslint-plugin](https://togithub.com/typescript-eslint/eslint-plugin)
requirement from ^5.37.0 to ^5.39.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3565](https://togithub.com/mermaid-js/mermaid/pull/3565)
- chore(deps): update
[@&#8203;types/node](https://togithub.com/types/node) requirement from
^18.7.21 to ^18.8.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3566](https://togithub.com/mermaid-js/mermaid/pull/3566)
- chore(deps-dev): update
[@&#8203;vitest/coverage-c8](https://togithub.com/vitest/coverage-c8)
requirement from ^0.23.2 to ^0.23.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3567](https://togithub.com/mermaid-js/mermaid/pull/3567)
- chore(deps-dev): update esbuild requirement from ^0.15.8 to ^0.15.10
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3569](https://togithub.com/mermaid-js/mermaid/pull/3569)
- chore(deps-dev): update typescript requirement from ^4.8.3 to ^4.8.4
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3573](https://togithub.com/mermaid-js/mermaid/pull/3573)
- chore(deps-dev): update
[@&#8203;applitools/eyes-cypress](https://togithub.com/applitools/eyes-cypress)
requirement from ^3.25.7 to ^3.27.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3568](https://togithub.com/mermaid-js/mermaid/pull/3568)
- chore(deps-dev): update vite requirement from ^3.0.9 to ^3.1.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3570](https://togithub.com/mermaid-js/mermaid/pull/3570)
- chore(deps-dev): update eslint-plugin-jest requirement from ^27.0.4 to
^27.1.0 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3571](https://togithub.com/mermaid-js/mermaid/pull/3571)
- chore(deps-dev): update
[@&#8203;commitlint/config-conventional](https://togithub.com/commitlint/config-conventional)
requirement from ^17.0.0 to ^17.1.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3572](https://togithub.com/mermaid-js/mermaid/pull/3572)
- Fix `docs:build` and `docs:verify` scripts by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3534](https://togithub.com/mermaid-js/mermaid/pull/3534)
- Fix husky `pre-commit` rules by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3536](https://togithub.com/mermaid-js/mermaid/pull/3536)
- Fix typos in README.md by
[@&#8203;elv-nate](https://togithub.com/elv-nate) in
[https://github.com/mermaid-js/mermaid/pull/3538](https://togithub.com/mermaid-js/mermaid/pull/3538)
- fix(tests): E2E by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3574](https://togithub.com/mermaid-js/mermaid/pull/3574)
- fix: pnpm clean in windows by
[@&#8203;arpansaha13](https://togithub.com/arpansaha13) in
[https://github.com/mermaid-js/mermaid/pull/3595](https://togithub.com/mermaid-js/mermaid/pull/3595)
- Update Cypress to v10 and fix E2E errors by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3459](https://togithub.com/mermaid-js/mermaid/pull/3459)
- ci(e2e-applitols): add applitools CI action by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3483](https://togithub.com/mermaid-js/mermaid/pull/3483)
- Remove webpack & babel by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3452](https://togithub.com/mermaid-js/mermaid/pull/3452)
- Add vitepress plugin by
[@&#8203;emersonbottero](https://togithub.com/emersonbottero) in
[https://github.com/mermaid-js/mermaid/pull/3476](https://togithub.com/mermaid-js/mermaid/pull/3476)
- ci(e2e): fix e2e action when running from fork by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3519](https://togithub.com/mermaid-js/mermaid/pull/3519)
- chore(deps-dev): update
[@&#8203;vitest/ui](https://togithub.com/vitest/ui) requirement from
^0.23.2 to ^0.23.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/3549](https://togithub.com/mermaid-js/mermaid/pull/3549)
- chore: Update demo diagrams for monorepo by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3545](https://togithub.com/mermaid-js/mermaid/pull/3545)
- Sync `docs/` with `packages/mermaid/src/docs` by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3586](https://togithub.com/mermaid-js/mermaid/pull/3586)
- chore: Add volta by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3628](https://togithub.com/mermaid-js/mermaid/pull/3628)
- chore: Node 18 by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3630](https://togithub.com/mermaid-js/mermaid/pull/3630)
- Configure Renovate by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/mermaid-js/mermaid/pull/3627](https://togithub.com/mermaid-js/mermaid/pull/3627)

##### Docs

- Added mermerd to integrations documentation by
[@&#8203;KarnerTh](https://togithub.com/KarnerTh) in
[https://github.com/mermaid-js/mermaid/pull/3399](https://togithub.com/mermaid-js/mermaid/pull/3399)
- Fix typo in documentation by
[@&#8203;dbartholomae](https://togithub.com/dbartholomae) in
[https://github.com/mermaid-js/mermaid/pull/3403](https://togithub.com/mermaid-js/mermaid/pull/3403)
- Update duplicate copy pasted directive description by
[@&#8203;mrmanc](https://togithub.com/mrmanc) in
[https://github.com/mermaid-js/mermaid/pull/3415](https://togithub.com/mermaid-js/mermaid/pull/3415)
- Docs/bug 3417 by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3419](https://togithub.com/mermaid-js/mermaid/pull/3419)
- Docs: add '..auto generated..' to .html documentation files by
[@&#8203;weedySeaDragon](https://togithub.com/weedySeaDragon) in
[https://github.com/mermaid-js/mermaid/pull/3420](https://togithub.com/mermaid-js/mermaid/pull/3420)
- Mention obsidian has native support for mermaid by
[@&#8203;IanLee1521](https://togithub.com/IanLee1521) in
[https://github.com/mermaid-js/mermaid/pull/3513](https://togithub.com/mermaid-js/mermaid/pull/3513)
- docs: replace `yarn` with `pnpm` in dev guide by
[@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/3535](https://togithub.com/mermaid-js/mermaid/pull/3535)
- Corrected theme variables reference table layout by
[@&#8203;marcastel](https://togithub.com/marcastel) in
[https://github.com/mermaid-js/mermaid/pull/3541](https://togithub.com/mermaid-js/mermaid/pull/3541)
- Working New Documentation Vitepress by
[@&#8203;emersonbottero](https://togithub.com/emersonbottero) in
[https://github.com/mermaid-js/mermaid/pull/3515](https://togithub.com/mermaid-js/mermaid/pull/3515)
- CODE_OF_CONDUCT Uploaded by
[@&#8203;swoyam2609](https://togithub.com/swoyam2609) in
[https://github.com/mermaid-js/mermaid/pull/3578](https://togithub.com/mermaid-js/mermaid/pull/3578)
- Automated docs spell-checking via GitHub Actions (and address all
reported issues) by
[@&#8203;SeanKilleen](https://togithub.com/SeanKilleen) in
[https://github.com/mermaid-js/mermaid/pull/3600](https://togithub.com/mermaid-js/mermaid/pull/3600)
- docs:Improved keywords in index.html by
[@&#8203;aryandeelwal](https://togithub.com/aryandeelwal) in
[https://github.com/mermaid-js/mermaid/pull/3579](https://togithub.com/mermaid-js/mermaid/pull/3579)
- Contribution.md updates by
[@&#8203;Aniket1026](https://togithub.com/Aniket1026) in
[https://github.com/mermaid-js/mermaid/pull/3614](https://togithub.com/mermaid-js/mermaid/pull/3614)
- docs: Add mermaid version to script URL by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/3596](https://togithub.com/mermaid-js/mermaid/pull/3596)

#### New Contributors

- [@&#8203;KarnerTh](https://togithub.com/KarnerTh) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3399](https://togithub.com/mermaid-js/mermaid/pull/3399)
- [@&#8203;mrmanc](https://togithub.com/mrmanc) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3415](https://togithub.com/mermaid-js/mermaid/pull/3415)
- [@&#8203;elliot-nelson](https://togithub.com/elliot-nelson) made their
first contribution in
[https://github.com/mermaid-js/mermaid/pull/3479](https://togithub.com/mermaid-js/mermaid/pull/3479)
- [@&#8203;emersonbottero](https://togithub.com/emersonbottero) made
their first contribution in
[https://github.com/mermaid-js/mermaid/pull/3476](https://togithub.com/mermaid-js/mermaid/pull/3476)
- [@&#8203;pje](https://togithub.com/pje) made their first contribution
in
[https://github.com/mermaid-js/mermaid/pull/3509](https://togithub.com/mermaid-js/mermaid/pull/3509)
- [@&#8203;IanLee1521](https://togithub.com/IanLee1521) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3513](https://togithub.com/mermaid-js/mermaid/pull/3513)
- [@&#8203;ashleybartlett](https://togithub.com/ashleybartlett) made
their first contribution in
[https://github.com/mermaid-js/mermaid/pull/3524](https://togithub.com/mermaid-js/mermaid/pull/3524)
- [@&#8203;pbrolin47](https://togithub.com/pbrolin47) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3533](https://togithub.com/mermaid-js/mermaid/pull/3533)
- [@&#8203;elv-nate](https://togithub.com/elv-nate) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3538](https://togithub.com/mermaid-js/mermaid/pull/3538)
- [@&#8203;marcastel](https://togithub.com/marcastel) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3541](https://togithub.com/mermaid-js/mermaid/pull/3541)
- [@&#8203;AndrewL-64](https://togithub.com/AndrewL-64) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3544](https://togithub.com/mermaid-js/mermaid/pull/3544)
- [@&#8203;swoyam2609](https://togithub.com/swoyam2609) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3578](https://togithub.com/mermaid-js/mermaid/pull/3578)
- [@&#8203;SeanKilleen](https://togithub.com/SeanKilleen) made their
first contribution in
[https://github.com/mermaid-js/mermaid/pull/3600](https://togithub.com/mermaid-js/mermaid/pull/3600)
- [@&#8203;aryandeelwal](https://togithub.com/aryandeelwal) made their
first contribution in
[https://github.com/mermaid-js/mermaid/pull/3579](https://togithub.com/mermaid-js/mermaid/pull/3579)
- [@&#8203;Aniket1026](https://togithub.com/Aniket1026) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/3614](https://togithub.com/mermaid-js/mermaid/pull/3614)

**Full Changelog**:
mermaid-js/mermaid@v9.1.7...v9.2.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [x] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/BirthdayResearch/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMi4wIiwidXBkYXRlZEluVmVyIjoiMzQuMTkuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: automatically add 'This file is auto generated...' comment to .html files
2 participants