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

Inline code formatting is broken #150

Open
ghost opened this issue Feb 7, 2023 · 1 comment
Open

Inline code formatting is broken #150

ghost opened this issue Feb 7, 2023 · 1 comment

Comments

@ghost
Copy link

ghost commented Feb 7, 2023

The inline code formatting is broken when it contains a URL: https://developer.wordpress.org/rest-api/extending-the-rest-api/routes-and-endpoints/

It is rendered fine in the GitHub preview: https://github.com/WP-API/docs/blob/master/extending-the-rest-api/routes-and-endpoints.md

@flexseth
Copy link
Contributor

This probably needs to be explicit <code> - opening and closing where necessary.

Where is this issue in the page?

The REST API provides us a way to match URIs to various resources in our WordPress install. By default, if you have pretty permalinks enabled, the WordPress REST API “lives” at /wp-json/. At our WordPress site https://ourawesomesite.com`, we can access the REST API's index by making a......
Link to highlight

https://ourawesomesite.com/wp-json`. The index route for the API is/which is why

https://ourawesomesite.com/wp-json/books`. However, this is not a good practice as we would end up polluting potential routes for the API. What if another plugin we wanted to register a books route as well? We would be in big trouble in that case, as the two routes would conflict with each other and only one could be used. The fourth parameter to

(I believe this has to do with links being determined to be HTML)
See this hint on SO

Will take a look at this during the docs office hours tomorrow.

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

No branches or pull requests

1 participant