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

Escape angle brackets for Plugins API reference docs #137

Merged
merged 3 commits into from
Nov 17, 2024

Conversation

brettle
Copy link
Contributor

@brettle brettle commented Nov 17, 2024

Summary of Changes

  1. Escaped angle brackets so that <name*> would display properly.

Copy link

netlify bot commented Nov 17, 2024

Deploy Preview for super-tapioca-5987ce ready!

Name Link
🔨 Latest commit df0475f
🔍 Latest deploy log https://app.netlify.com/sites/super-tapioca-5987ce/deploys/673a3738e7d4420008b7694e
😎 Deploy Preview https://deploy-preview-137--super-tapioca-5987ce.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.

@thescientist13 thescientist13 added bug Something isn't working docs Greenwood specific content like docs and guides labels Nov 17, 2024
Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Ah good catch.

This one still looks a little funny from what I can see in the preview at least
https://deploy-preview-137--super-tapioca-5987ce.netlify.app/docs/reference/plugins-api/#source
Screenshot 2024-11-17 at 12 20 41 PM

Maybe we should replace with { and } to make things easy, e.g.

- _/artists/{name1}/_
- _/artists/{name2}/_
- _/artists/{nameN}/_

Or we could use the HTML entity version? &lt; and &gt?

I have no strong preference either way.

@thescientist13 thescientist13 changed the title Escape angle brackets. Escape angle brackets for Plugins API reference docs Nov 17, 2024
Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@thescientist13 thescientist13 merged commit 9c2f0de into ProjectEvergreen:main Nov 17, 2024
5 checks passed
@brettle brettle deleted the patch-4 branch November 18, 2024 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Greenwood specific content like docs and guides
Projects
Development

Successfully merging this pull request may close these issues.

2 participants