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
chore: add formatters page #16018
chore: add formatters page #16018
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
In the current release process, we generate this file by using the actual formatters. Given that we aren't adding any new formatters, maybe it's not worth doing that....@eslint/eslint-tsc thoughts on that? In the meantime, there are some linting errors in the file. |
I agree. If it turns out at some point that it would be useful to autogenerate this page again, we could implement that later. |
docs/src/user-guide/formatters.md
Outdated
|
||
### html | ||
|
||
<iframe src="html-formatter-example.html" width="100%" height="460px"></iframe> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also need this file.
Current site: https://eslint.org/docs/user-guide/formatters/#html
Deploy preview for this PR: https://deploy-preview-16018--docs-eslint.netlify.app/user-guide/formatters#html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can just copy-paste that file from the current website:
https://github.com/eslint/website/blob/master/docs/user-guide/formatters/html-formatter-example.html
And we could keep the same structure:
docs/src/user-guide/formatters/index.md
docs/src/user-guide/formatters/html-formatter-example.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Closing in favor of #16036 |
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
Ref: #16009
What changes did you make? (Give an overview)
Added formaters page
Is there anything you'd like reviewers to focus on?