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

sequenceDiagram.md += previews under snippets #2878

Closed
wants to merge 1 commit into from

Conversation

gwpl
Copy link

@gwpl gwpl commented Apr 1, 2022

📑 Summary

Brief description about the content of your PR.

Resolves #

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added unit/e2e tests (if appropriate)
  • 🔖 targeted develop branch

@Yash-Singh1
Copy link
Member

Yash-Singh1 commented Apr 1, 2022

mermaid-example already adds the preview and the code: https://github.com/mermaid-js/mermaid/blob/develop/docs/index.html#L102. This will add duplicate previews (the same diagram appears twice).

@gwpl
Copy link
Author

gwpl commented Apr 4, 2022

I was reading directly from github:
https://github.com/mermaid-js/mermaid/blob/develop/docs/stateDiagram.md
and here is DOES NOT produce preview.

IIUC github/gitlab they are using mermaid code - maybe something has to be fixed in that manner to make marmaid-example work also on those platforms ?

(just created issue ticket: #2895 to track this)

@knsv
Copy link
Collaborator

knsv commented Apr 7, 2022

I agree that it would be nice to having it look good at both places!

@Yash-Singh1
Copy link
Member

I agree that it would be nice to having it look good at both places!

Yes, but the problem is that it will duplicate the previews in the official docs.

@sidharthv96 sidharthv96 self-assigned this Sep 13, 2022
@sidharthv96
Copy link
Member

Closed in #3401

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.

4 participants