docs: Add development example page. #4714
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4714 +/- ##
==========================================
+ Coverage 71.98% 72.15% +0.17%
==========================================
Files 144 144
Lines 14583 14583
Branches 563 563
==========================================
+ Hits 10497 10522 +25
+ Misses 3955 3931 -24
+ Partials 131 130 -1
Flags with carried forward coverage won't be shown. Click here to find out more. |
sidharthv96
force-pushed
the
sidv/exampleDev
branch
from
9d42043
to
b10aeff
Compare
sidharthv96
force-pushed
the
sidv/exampleDev
branch
from
b10aeff
to
06e4a63
Compare
nirname
requested changes
Aug 9, 2023
sidharthv96
commented
Aug 9, 2023
sidharthv96
commented
Aug 9, 2023
nirname
approved these changes
Aug 9, 2023
… into sidv/exampleDev * 'sidv/exampleDev' of https://github.com/mermaid-js/mermaid: Update packages/mermaid/src/docs/community/development.md Update docs/community/development.md
nirname
approved these changes
Aug 9, 2023
fuxingloh
referenced
this pull request
in fuxingloh/contented
Aug 28, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.3.1` -> `10.4.0`](https://renovatebot.com/diffs/npm/mermaid/10.3.1/10.4.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.4.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.4.0) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.3.1...v10.4.0) #### Features - feat: Support config in frontmatter. by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4750](https://togithub.com/mermaid-js/mermaid/pull/4750) - feat(sankey): Show values by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4748](https://togithub.com/mermaid-js/mermaid/pull/4748) #### Docs - docs: Add development example page. by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4714](https://togithub.com/mermaid-js/mermaid/pull/4714) - Documentation for [#​2509](https://togithub.com/mermaid-js/mermaid/issues/2509) by [@​jason-curtis](https://togithub.com/jason-curtis) in [https://github.com/mermaid-js/mermaid/pull/4740](https://togithub.com/mermaid-js/mermaid/pull/4740) - Fixes to Docs sidebar, main page and badges by [@​nirname](https://togithub.com/nirname) in [https://github.com/mermaid-js/mermaid/pull/4742](https://togithub.com/mermaid-js/mermaid/pull/4742) - Split development documentation into several pages by [@​nirname](https://togithub.com/nirname) in [https://github.com/mermaid-js/mermaid/pull/4744](https://togithub.com/mermaid-js/mermaid/pull/4744) - Docs: update Latest News section by [@​huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/4768](https://togithub.com/mermaid-js/mermaid/pull/4768) #### Chores - Update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4732](https://togithub.com/mermaid-js/mermaid/pull/4732) - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4731](https://togithub.com/mermaid-js/mermaid/pull/4731) - convert `assignWithDepth` to TS by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/4717](https://togithub.com/mermaid-js/mermaid/pull/4717) - convert `diagrams/common/svgDrawCommon.js` to ts by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/4724](https://togithub.com/mermaid-js/mermaid/pull/4724) - ci(release-drafter): add more release notes categories by [@​aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4752](https://togithub.com/mermaid-js/mermaid/pull/4752) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4753](https://togithub.com/mermaid-js/mermaid/pull/4753) - standardized pie definitions by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/4501](https://togithub.com/mermaid-js/mermaid/pull/4501) - Remove Circular Dependencies by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4761](https://togithub.com/mermaid-js/mermaid/pull/4761) - chore: Enforce type imports by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4763](https://togithub.com/mermaid-js/mermaid/pull/4763) - chore: Preview PRs with mermaid-live-editor on Netlify by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4769](https://togithub.com/mermaid-js/mermaid/pull/4769) #### New Contributors - [@​jason-curtis](https://togithub.com/jason-curtis) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4740](https://togithub.com/mermaid-js/mermaid/pull/4740) **Full Changelog**: mermaid-js/mermaid@v10.3.1...v10.4.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:eyJjcmVhdGVkSW5WZXIiOiIzNi41Ni4wIiwidXBkYXRlZEluVmVyIjoiMzYuNTYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Add documentation on how to see local changes easily when developing.
📏 Design Decisions
We've had many contributors ask this. Now they can have their own dev pages without committing them into the repo.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch