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 howto.md #17

Merged
merged 4 commits into from
Jun 14, 2024
Merged

Update howto.md #17

merged 4 commits into from
Jun 14, 2024

Conversation

MathewBiddle
Copy link
Contributor

adding guidance for mermaid diagrams from ioos/documentation-theme-jekyll#16 (comment)

@ocefpaf @mwengren please review and merge if you approve. Thanks!

adding guidance for mermaid diagrams from ioos/documentation-theme-jekyll#16 (comment)
fixing some formatting issues
_docs/howto.md Outdated Show resolved Hide resolved
_docs/howto.md Outdated Show resolved Hide resolved
MathewBiddle and others added 2 commits June 14, 2024 15:19
@MathewBiddle
Copy link
Contributor Author

Worked!!
image

@MathewBiddle
Copy link
Contributor Author

@mwengren please review and merge when ready. Thanks!

@mwengren
Copy link
Member

Weird, when I do either 'view rich diff' or view raw file, it doesn't render the mermaid diagram (maybe that's to be expected), but I'm sure it must work, so I'll just merge. Thanks!

@mwengren mwengren merged commit 4b7874f into gh-pages Jun 14, 2024
@MathewBiddle MathewBiddle deleted the MathewBiddle-patch-1 branch June 14, 2024 20:25
@MathewBiddle
Copy link
Contributor Author

It's probably something to do with the javascript not on that rich diff html page.

Seems to render fine on the website:
https://ioos.github.io/ioos-documentation-jekyll-skeleton/howto.html#adding-mermaid-diagrams-to-a-page

@ocefpaf
Copy link
Member

ocefpaf commented Jun 17, 2024

Yep. While GitHub added mermaid support for PRs and issues text boxes, they did not add it to file previews. Makes sense b/c if they start adding all sort of JS support the preview would be super bloated, slow, and unsafe.

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.

3 participants