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

Markdown rendering issue with angle brackets <> #27104

Closed
wants to merge 2 commits into from

Conversation

maheshwaghmare
Copy link
Contributor

@maheshwaghmare maheshwaghmare commented Nov 19, 2020

Description

On the page https://developer.wordpress.org/block-editor/packages/packages-dom/ the markdown render fail due to the angle brackets.

See
Markdown render issue

How has this been tested?

Not tested. But, It'll fix the markdown render issue.

Screenshots

Checklist:

  • My code follows the WordPress code style.
  • My code is tested.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Nov 19, 2020
Copy link
Contributor

@talldan talldan left a comment

Choose a reason for hiding this comment

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

Thanks for catching this!

This particular doc needs an extra step. You'll just need to run npm run docs:build, commit and push the changes. Let me know if you need any help.

@gziolo
Copy link
Member

gziolo commented Nov 20, 2020

This part of README file is auto-generated from JSDoc so it needs to be changed there first.

> [email protected] docs:build C:\xampp\htdocs\dev\wp-content\plugins\gutenberg
> node ./docs/tool/index.js && node ./bin/api-docs/update-api-docs.js command.
@maheshwaghmare
Copy link
Contributor Author

@talldan and @gziolo thanks for the suggestions.

I have just re-generated the docs with command npm run docs:build

@gziolo
Copy link
Member

gziolo commented Nov 25, 2020

It removed your changes. You need to apply changes in the JS file in JSDoc comments and run the same command again 😃

@skorasaurus
Copy link
Member

hi @maheshwaghmare

Thanks for contributing; I think you'll need to make those changes in

* of text in the document, and not selection inside <input> and <textarea>

@gziolo gziolo added the [Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. label Feb 3, 2021
Base automatically changed from master to trunk March 1, 2021 15:44
@mkaz
Copy link
Member

mkaz commented Dec 10, 2021

Looks like this was fixed in #34813

@mkaz mkaz closed this Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants