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

Roadmap: Support mermaid graphs for Github #43

Closed
6 tasks done
Aetherinox opened this issue Mar 27, 2024 · 0 comments
Closed
6 tasks done

Roadmap: Support mermaid graphs for Github #43

Aetherinox opened this issue Mar 27, 2024 · 0 comments
Assignees
Labels
Type ◦ Roadmap Feature or bug currently planned for implementation

Comments

@Aetherinox
Copy link
Owner

Aetherinox commented Mar 27, 2024

Summary

At present, Github gists now support Mermaid diagrams. Github provides a share button to the top right which includes a javascript file you must include on your page. However, even on a stock HTML page with no engine, Github mermaid graphs do not render. Unknown if Github plans to fix this, but it currently has issues with:

  • Firefox
  • Opera
  • Chrome



Proposal

An alternative way to render mermaid diagrams would be to utilize webviewer to render the diagram in the user's Obsidian note. It has been tested, and gives the user full control over viewing the diagram and navigating.

The downside is that webviewer treats the window as a full-blown browser, so they would be viewing the entire page for the gist. They would be unable to edit the diagram from their Obsidian note unless they physically sign into that browser window as they would on a normal browser.

This brings up the issue of also supporting cookies and storing them for the user.




Objectives

  • Integrate electron web browser
  • Support signin / cookies
  • Integrate new integrated browser into gistr
  • Add control options for user to modify how the window appears:
    • Zoom setting
    • Height setting
@EuropaServ EuropaServ changed the title Support mermaid graphs for Github Roadmap: Support mermaid graphs for Github Mar 27, 2024
@EuropaServ EuropaServ added the Type ◦ Roadmap Feature or bug currently planned for implementation label Mar 27, 2024
Aetherinox added a commit that referenced this issue Mar 29, 2024
Add integrated browser package to help support gist mermaid charts

Refs: #43
Aetherinox added a commit that referenced this issue Mar 29, 2024
Aetherinox added a commit that referenced this issue Mar 29, 2024
New constants stored for integrated Saturyn browser

Refs: #43
Aetherinox added a commit that referenced this issue Mar 29, 2024
…s for mermaid charts #43

Add support for loading integrated browser windows for mermaid charts

Refs: #43
Aetherinox added a commit that referenced this issue Mar 29, 2024
#43

Add new params 'zoom' and 'height' as codeblock parameters.
Add support for integrated gistr pages

Refs: #43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type ◦ Roadmap Feature or bug currently planned for implementation
Projects
None yet
Development

No branches or pull requests

2 participants