Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@ZzMzaw
Copy link
Contributor

@ZzMzaw ZzMzaw commented Oct 7, 2024

Summary

Mermaid usage was missing in the documentation.
I just added it as for any other shortcode.

Changes

Add mermaid usage in documentation

Accessibility

Nothing particular for this change, just reused other similar shortcode usage as base.

Screenshots

image

Type of change

  • Bug fix (fixes an issue without altering functionality)
  • New feature (adds non-breaking functionality)
  • Breaking change (alters existing functionality)
  • UI/UX improvement (enhances user interface without altering functionality)
  • Refactor (improves code quality without altering functionality)
  • Documentation update
  • Other (please describe below)

Checklist

  • I have verified the accessibility of my changes
  • I have tested all possible scenarios for this change
  • I have updated theme.toml with a sane default for the feature
  • I have made corresponding changes to the documentation:
    • Updated config.toml comments
    • Updated theme.toml comments
    • Updated "Mastering tabi" post in English
    • (Optional) Updated "Mastering tabi" post in Spanish
    • (Optional) Updated "Mastering tabi" post in Catalan

@ZzMzaw ZzMzaw requested a review from welpo as a code owner October 7, 2024 03:49
@netlify
Copy link

netlify bot commented Oct 7, 2024

βœ… Deploy Preview for tabi-demo ready!

Name Link
πŸ”¨ Latest commit ae361ce
πŸ” Latest deploy log https://app.netlify.com/sites/tabi-demo/deploys/67046dcde657ea00084c659b
😎 Deploy Preview https://deploy-preview-407--tabi-demo.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ZzMzaw
Copy link
Contributor Author

ZzMzaw commented Oct 7, 2024

Oh, I just noticed there was an example just above in fact which would explain why there is no specific usage section.
Not seeing usage section like for other shortcodes let me think it was missing and I was confused when I tried to use the shortcode.
I let you decide if it is worth keeping or not.

@welpo
Copy link
Owner

welpo commented Oct 7, 2024

Makes sense, for consistency sake!

Thank you :)

@welpo welpo merged commit 3fddb1f into welpo:main Oct 7, 2024
7 checks passed
@ZzMzaw ZzMzaw deleted the fix/mermaid-usage branch October 15, 2024 04:49
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