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

feat(docs): upgrade mkdocs/mermaid #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

noelmcloughlin
Copy link
Contributor

@noelmcloughlin noelmcloughlin commented Feb 26, 2024

This PR is to upgrade mkdocs-material and mermaid2 to later versions.

@noelmcloughlin noelmcloughlin marked this pull request as draft February 26, 2024 19:04
@noelmcloughlin
Copy link
Contributor Author

Wait for decision on #99 and more testing

@noelmcloughlin noelmcloughlin force-pushed the mkdocs branch 2 times, most recently from f647192 to b2e6740 Compare February 26, 2024 19:39
@noelmcloughlin
Copy link
Contributor Author

noelmcloughlin commented Feb 27, 2024

Seems to work fine.

Note: Mermaid dislikes Linkml class names which can collidide with mermaid keywords. For example, ontology class causes syntax error, but OntologyClass does not.

@noelmcloughlin noelmcloughlin marked this pull request as ready for review February 27, 2024 22:19
Copy link
Member

@cmungall cmungall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be committing the mermaid.min.js itself

@noelmcloughlin
Copy link
Contributor Author

Hi @cmungall
I will remove that from this PR and address via #118

@noelmcloughlin noelmcloughlin force-pushed the mkdocs branch 5 times, most recently from ae5c45c to e58bbaf Compare August 18, 2024 23:32
@noelmcloughlin noelmcloughlin marked this pull request as ready for review August 18, 2024 23:33
@noelmcloughlin
Copy link
Contributor Author

Ready for review.

@noelmcloughlin
Copy link
Contributor Author

Examples for sample "void" schema
Dark mode (Dracula):
image

Normal mode:
image

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.

2 participants