Ashley Engelund (weedySeaDragon @ github)
bd5b5cda06
Merge remote-tracking branch 'origin/docs/3682-developer-contributing' into docs/3682-developer-contributing
...
# Conflicts:
# packages/mermaid/src/docs/community/development.md
2022-11-19 09:23:24 -08:00
Ashley Engelund (weedySeaDragon @ github)
fee63d83ee
update related /docs file
2022-11-19 09:16:19 -08:00
Doug Finke
2a0f6d4cc9
Integrations added - Visual Studio Code [Polyglot Interactive Notebooks]
2022-11-19 11:20:13 -05:00
endolith
e3b9dbdf13
Fix typos
2022-11-19 09:33:01 -05:00
Mason Malone
70f024735b
Add title support using YAML frontmatter
2022-11-18 20:42:54 -08:00
Ashley Engelund
0333bc172c
spelling: description; .. help us keep release notes organized
...
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2022-11-18 15:39:29 -08:00
Ashley Engelund
71d2175e19
questions? search in... capitalize Search, + closed issues
...
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2022-11-18 15:38:52 -08:00
Ashley Engelund (weedySeaDragon @ github)
bd8f620480
updates based on sidharthv96's review
2022-11-18 15:24:10 -08:00
Alois Klink
fd76e0e270
chore: replace dagre/dagre-d3 with dagre-d3-es
...
Replace the dagre and dagre-d3 libraries with dagre-d3-es.
Both dagre and dagre-d3 are deprecated and unmaintained,
and haven't been updated for more than 3 years.
Since dagre-d3 still requires an old version of d3, this causes
a bunch of security warnings,
e.g. https://github.com/advisories/GHSA-36jr-mh4h-2g58
The [dagre-d3-es](https://github.com/tbo47/dagre-es ) package is a fork
that contains support for `"d3": "^7.6.1"`. Also, it's ESM, so we will
hopefully get smaller bundle sizes too. The only issue is that this
fork isn't very well used (only has 3000 weekly downloads),
compared to `dagre-d3`'s 250,000 weekly downloads.
(although to be fair, a large proportion of dagre-d3's downloads
probably come from mermaid)
Since it's is a less popular package,
**I've pinned `dagre-d3-es` to `"7.0.2"` instead of `"^7.0.2"`**.
This does mean if there is a bug in `dagre-d3-es`, we will have to
manually bump it ourselves, but it also means we won't accidentally
be sending a buggy version of `dagre-d3-es` out to users in cases
something changes (it might be worth disabling renovate for this
if we're feeling paranoid!)
2022-11-18 18:33:05 +00:00
Alois Klink
537a627b75
test(e2e): test for mindmap before snapshot
...
Sometimes, the mindmap e2e tests take a snapshot when the mindmap
SVG has been created, but hasn't yet been fully rendered.
This adds a quick check for a mindmap section root, so that the
snapshot is only taken after the mindmap diagram has started
rendering.
I was also running into JSDoc ESLint warnings, so I moved the file
into a TypeScript file to fix those warnings.
2022-11-18 18:31:14 +00:00
Alois Klink
57edcfe87d
test(e2e): remove unused mermaid.spec.js file
...
All tests have been moved to `mindmap.spec.js` in a previous commit.
2022-11-18 18:07:40 +00:00
Alois Klink
b9dcdb00a5
test(e2e): move mindmap tests to mindmap.spec.js
...
Currently, we have mindmap tests in the
cypress/integration/rendering/mermaid.spec.js which is a bit
odd. They should probably all be in the mindmap.spec.js file.
2022-11-18 17:58:17 +00:00
Ashley Engelund (weedySeaDragon @ github)
3fbc26dfc9
Merge remote-tracking branch 'MERMAID/develop' into docs/3682-developer-contributing
2022-11-18 09:50:21 -08:00
Sidharth Vinod
09ed41b7d2
Merge pull request #3807 from aloisklink/docs/update-code-highlighting-theme
...
Use `github-dark` to highlight fence blocks in vitepress docs
2022-11-18 23:09:59 +05:30
Ashley Engelund (weedySeaDragon @ github)
a867400d56
(minor) fix formatting; add "upvoting" to cSpell.json
2022-11-18 09:37:57 -08:00
Alois Klink
6e234f135d
docs: create some basic mermaid mindmap demos
2022-11-18 17:32:23 +00:00
Ashley Engelund (weedySeaDragon @ github)
acebcbffc8
/doc files changed
2022-11-18 09:06:48 -08:00
Ashley Engelund (weedySeaDragon @ github)
449cbdfd02
make TODOs bold, ital so they're obv
2022-11-18 09:03:01 -08:00
Ashley Engelund (weedySeaDragon @ github)
3bdcfd9160
add TODO - PRs should start with... (fix|bug|feat|...)
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
9c0b81cee0
sidebar menu: remove sub-sub sections since sub menus cannot be collapsed
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
6b8f60efcf
nav menu: contributing now points to src/doc about contributing
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
950832e56b
Minor wording changes to Tech Reqs/Setup
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
535a1fc8cf
add mermaid diagram
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
548ae5b023
sidebar: add sub-entries for Development/contribution
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
16d1610d75
clarify section headings; add TODO
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
e02240450a
delete vdocs dir; it not longer exists
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
5eee76764d
add TBD/comments in 'Contribute to Documentation....' section
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
dabda9d4ef
CONTRIBUTING.md is note (with link) to development.md on doc site
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
135893f067
copy working draft to vdocs/community/development.md
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
95120c3f21
added main TOC headings
2022-11-18 08:52:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
47b695c3c5
reorganize, start adding text
2022-11-18 08:52:16 -08:00
Sidharth Vinod
7306b5ac45
feat: Add size inspection plugin
2022-11-18 17:52:55 +05:30
Sidharth Vinod
0854bab124
fix: Remove diagram dependency from mermaidAPI
2022-11-18 16:51:50 +05:30
Sidharth Vinod
fa51121f29
chore(split): Error
2022-11-18 16:30:54 +05:30
Sidharth Vinod
0b4c6f6477
chore(split): Journey
2022-11-18 16:22:38 +05:30
Sidharth Vinod
e5768454f1
chore(split): State Diagram
2022-11-18 16:19:38 +05:30
Sidharth Vinod
89b5eb56f2
chore(split): Orchestration
2022-11-18 16:11:19 +05:30
Sidharth Vinod
616c969a03
chore(split): Flow type
2022-11-18 16:11:03 +05:30
Sidharth Vinod
4fd826ac8c
chore(split): Sequence
2022-11-18 16:10:51 +05:30
Sidharth Vinod
6d5a6ad0c8
chore(split): Requirement
2022-11-18 16:10:42 +05:30
Sidharth Vinod
e0cd76e6fd
chore(split): Pie
2022-11-18 16:10:25 +05:30
Sidharth Vinod
f03364f328
chore(split): Info
2022-11-18 16:10:15 +05:30
Sidharth Vinod
25bc381361
chore(split): gitGraph
2022-11-18 16:10:06 +05:30
Sidharth Vinod
38e5c3a81e
chore(split): Gantt
2022-11-18 16:09:56 +05:30
Sidharth Vinod
43aa831dd2
chore(split): ER
2022-11-18 16:09:45 +05:30
Sidharth Vinod
4492c5ed4e
chore(split): classDiagram
2022-11-18 16:09:36 +05:30
Sidharth Vinod
5dec9eb2f5
fix: C4 type
2022-11-18 16:09:10 +05:30
pbrolin47
e2a0c434cc
Merge pull request #3810 from mermaid-js/sidv/doc/mindmap
...
Mindmap integration docs
2022-11-18 11:01:38 +01:00
pbrolin47
804a23595d
Merge pull request #3797 from mermaid-js/sidv/redirectOldDocs
...
feat: Redirect old documentation links.
2022-11-18 10:46:34 +01:00
Knut Sveidqvist
8655db371e
Merge pull request #3762 from avijit1258/bug/3728_comments_not_ignored_composite_states
...
comments in states are skipped now
2022-11-18 10:45:01 +01:00
