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

Enhance Mermaid Diagrams and Definition Lists #666

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Enhance Mermaid Diagrams and Definition Lists #666

merged 2 commits into from
Aug 22, 2024

Conversation

osterman
Copy link
Member

@osterman osterman commented Aug 22, 2024

what

  • Improve formatting for mermaid diagrams
  • Support icons in mermaid diagrams
  • Automatic link terms in definition lists and support smooth scrolling to terms
  • Update formatting for tutorials

why

  • We're moving to use more mermaid diagrams because they are easier to main and searchable with algolia
  • Using icons makes diagrams easier to digest and comparable to mainstream diagraming tools
  • When there are a lot of definitions on a page, it's helpful to be able to link to a specific one

demo

image

CleanShot 2024-08-21 at 20 39 59

@osterman osterman changed the title Copy 11 Enhance Mermaid Diagrams Aug 22, 2024
@osterman osterman changed the title Enhance Mermaid Diagrams Enhance Mermaid Diagrams and Definition Lists Aug 22, 2024
@osterman osterman merged commit 8790c5d into master Aug 22, 2024
3 checks passed
@osterman osterman deleted the copy-11 branch August 22, 2024 12:58
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