Skip to content

Add document for parameters of Parser.parseHtml #6576

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

Merged
merged 1 commit into from
Jul 25, 2025

Conversation

nanto
Copy link
Contributor

@nanto nanto commented Jul 24, 2025

Current document for Parser.parseHtml method lacks descriptions for some parameters. This pull request adds such descriptions to cover all properties of HTMLParserOptions type.

@nanto
Copy link
Contributor Author

nanto commented Jul 24, 2025

Should we commit the result of running pnpm run docs:api command? That contains not only docs/api/parser.md but also docs/api/canvas.md, docs/api/component.md, and docs/api/editor.md.

@artf artf merged commit f64c4c1 into GrapesJS:dev Jul 25, 2025
3 checks passed
@artf
Copy link
Member

artf commented Jul 25, 2025

Thanks @nanto

Should we commit the result of running pnpm run docs:api command? That contains not only docs/api/parser.md but also docs/api/canvas.md, docs/api/component.md, and docs/api/editor.md.

Those are tracked in the repository, but no worries, they are regenerated anyway when we deploy the docs.

@nanto
Copy link
Contributor Author

nanto commented Jul 27, 2025

Thank you! I'm glad I could help.

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