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

docs: escape ] in code-block filename #2275

Merged
merged 1 commit into from
Jul 30, 2023
Merged

docs: escape ] in code-block filename #2275

merged 1 commit into from
Jul 30, 2023

Conversation

nobkd
Copy link
Contributor

@nobkd nobkd commented Jul 30, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Adds \\ to every code-block filename with ] to escape it. This prevents the filename from being cropped.

Currently, the filename pages/articles/[name].vue is displayed as pages/articles/[name because it is cropped incorrectly.


Related & Info

See this PR nuxt/content#2169, released in nuxt/content since v2.7.2, to fix this with an escape character

The fix was shipped in Docus v1.14.4 with nuxt-themes/docus@44aefd5.

So this will work after #1989 was merged.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@nuxt-studio
Copy link

nuxt-studio bot commented Jul 30, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
i18n Edit on Studio β†—οΈŽ View Live Preview b363d7e

Copy link
Collaborator

@kazupon kazupon left a comment

Choose a reason for hiding this comment

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

Good catch!
Thanks!

@kazupon kazupon merged commit 30abf19 into nuxt-modules:next Jul 30, 2023
@nobkd
Copy link
Contributor Author

nobkd commented Jul 30, 2023

πŸ‘Great.

Still, this'll look wrong until Docus v1.14.4 is used.

Update: Seems, that there's a different issue in Nuxt Content before it works
Created an issue nuxt/content#2201

This should just work, when this is resolved and shipped with Docus. I'll get in touch otherwise.

Note
This turned out to work just fine with Docus v1.14.4

@nobkd nobkd deleted the patch-1 branch July 30, 2023 12:28
DarthGigi pushed a commit to DarthGigi/i18n that referenced this pull request Apr 16, 2024
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.

None yet

3 participants