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

Update README.md #4780

Merged
merged 1 commit into from Sep 7, 2023
Merged

Update README.md #4780

merged 1 commit into from Sep 7, 2023

Conversation

jgreywolf
Copy link
Contributor

📑 Summary

Quick fix to remove namespace from readme class definition since github has not been update to the version that uses namespaces

Resolves #4647

Quick fix to remove namespace from readme class definition since github has not been update to the version that uses namespaces
@netlify
Copy link

netlify bot commented Aug 27, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit b6d5497
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/64ebcd4b250ec50008aba6d5
😎 Deploy Preview https://deploy-preview-4780--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Aug 27, 2023

Codecov Report

Merging #4780 (b6d5497) into develop (ed819e9) will decrease coverage by 4.71%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #4780      +/-   ##
===========================================
- Coverage    77.05%   72.35%   -4.71%     
===========================================
  Files          146      146              
  Lines        14573    14573              
  Branches       592      592              
===========================================
- Hits         11229    10544     -685     
- Misses        3225     3890     +665     
- Partials       119      139      +20     
Flag Coverage Δ
e2e 77.51% <ø> (-6.42%) ⬇️
unit 45.55% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 22 files with indirect coverage changes

@sidharthv96
Copy link
Member

sidharthv96 commented Aug 28, 2023

I don't think we should remove it from the readme. Instead, adding a note saying this feature was added with vX.X.X and will render when GitHub supports that version should be enough.

Maybe even a link to live editor with the working diagram would be nice.

@jgreywolf
Copy link
Contributor Author

I don't think we should remove it from the readme. Instead, adding a note saying this feature was added with vX.X.X and will render when GitHub supports that version should be enough.

Maybe even a link to live editor with the working diagram would be nice.

I can see keeping it listed there, and making the comment - but having a syntax error showing in the readme seems like a bad impression

@sidharthv96 sidharthv96 added this pull request to the merge queue Sep 7, 2023
Merged via the queue into develop with commit 00d06c7 Sep 7, 2023
27 checks passed
@sidharthv96 sidharthv96 deleted the jgreywolf-patch-1 branch September 7, 2023 18:17
fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Oct 3, 2023
[![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) | [`10.4.0` ->
`10.5.0`](https://renovatebot.com/diffs/npm/mermaid/10.4.0/10.5.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v10.5.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.5.0):
10.5.0

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.4.0...v10.5.0)

#### What's Changed

##### Features

- feat(er): add entity name alias by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4758

##### Bugfixes

- Fix Twitter fontawesome class in flowchart.md by
[@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) in
[mermaid-js/mermaid#4723
- fix(pie): align slices and legend orders by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4774
- Update class member handling by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4534
- fix(er): allow underscore as leading char by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4776
- Align arrows on sequence diagram by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4804
- fix: Allow hollow markers on edges by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4788
- fix: Fix for vulnerability making it possible to add javascript in
class names by [@&#8203;knsv](https://togithub.com/knsv)

##### Documentation

- Docs/2910 Remove n00b and fix some docs by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#4767
- fix: typos by [@&#8203;omahs](https://togithub.com/omahs) in
[mermaid-js/mermaid#4801
- "CSS" instead of "css" in flowchart.md by
[@&#8203;jakeboone02](https://togithub.com/jakeboone02) in
[mermaid-js/mermaid#4797
- fix(docs): Correct repeated text in flowchart.md by
[@&#8203;andriy-koz](https://togithub.com/andriy-koz) in
[mermaid-js/mermaid#4810
- Update link to Discourse theme component by
[@&#8203;gschlager](https://togithub.com/gschlager) in
[mermaid-js/mermaid#4811
- New Mermaid Live Editor for Confluence Cloud by
[@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) in
[mermaid-js/mermaid#4814
- Update classDiagram.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4781
- Support member definition to initialize class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4786
- fix: Add support for `~test Array~string~` back in Class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4805
- Added support for millisecond and second to gantt tickInterval by
[@&#8203;vertxxyz](https://togithub.com/vertxxyz) in
[mermaid-js/mermaid#4778
- Add directive support to all diagrams by preprocessing by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4759
- Update README.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4780

##### Chores

- chore(deps): update all minor dependencies (minor) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4783
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4782
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4809
- chore: move `commonDb` into `diagrams/common/commonDb` by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4802
- Use utf8 encoding in Jupyter example by
[@&#8203;jonashaag](https://togithub.com/jonashaag) in
[mermaid-js/mermaid#4701
- Update flowchart.md by [@&#8203;Ogglas](https://togithub.com/Ogglas)
in
[mermaid-js/mermaid#4792
- Update flowchart.md by [@&#8203;dsblank](https://togithub.com/dsblank)
in
[mermaid-js/mermaid#4798
- Refactor `cypress/helpers/util.ts` by
[@&#8203;RohanHandore](https://togithub.com/RohanHandore) in
[mermaid-js/mermaid#4340
- refactor: Fix typings in utils.ts by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4826
- Support ClassDefs in external diagrams by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4819
- Fix: flowchartElk Arrow overlap by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4830
- Give markers unique id's per graph by
[@&#8203;chadfawcett](https://togithub.com/chadfawcett) in
[mermaid-js/mermaid#4825

#### New Contributors

- [@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) made
their first contribution in
[mermaid-js/mermaid#4723
- [@&#8203;omahs](https://togithub.com/omahs) made their first
contribution in
[mermaid-js/mermaid#4801
- [@&#8203;jakeboone02](https://togithub.com/jakeboone02) made their
first contribution in
[mermaid-js/mermaid#4797
- [@&#8203;andriy-koz](https://togithub.com/andriy-koz) made their first
contribution in
[mermaid-js/mermaid#4810
- [@&#8203;gschlager](https://togithub.com/gschlager) made their first
contribution in
[mermaid-js/mermaid#4811
- [@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) made their first
contribution in
[mermaid-js/mermaid#4814
- [@&#8203;vertxxyz](https://togithub.com/vertxxyz) made their first
contribution in
[mermaid-js/mermaid#4778
- [@&#8203;jonashaag](https://togithub.com/jonashaag) made their first
contribution in
[mermaid-js/mermaid#4701
- [@&#8203;Ogglas](https://togithub.com/Ogglas) made their first
contribution in
[mermaid-js/mermaid#4792
- [@&#8203;dsblank](https://togithub.com/dsblank) made their first
contribution in
[mermaid-js/mermaid#4798
- [@&#8203;RohanHandore](https://togithub.com/RohanHandore) made their
first contribution in
[mermaid-js/mermaid#4340
- [@&#8203;chadfawcett](https://togithub.com/chadfawcett) made their
first contribution in
[mermaid-js/mermaid#4825

**Full Changelog**:
mermaid-js/mermaid@v10.4.0...v10.5.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.

---

- [ ] <!-- 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://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjMiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

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.

README not rendering class diagram
2 participants