-
Notifications
You must be signed in to change notification settings - Fork 24.8k
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
docs(api): avoid headings in decorators #22682
Comments
Can we disallow H2 H3 etc in API reference markup everywhere? In other words, all headings are ones that are generated based on appropriate dgeni tagging or the generation tools? Can we disallow H2 H3 etc in tables? If the generator finds something that would be a heading inside a table, then it makes that text just bold on its own line? Either of those would fix the TOC for existing content. Longer term, obviously, a rewrite of this kind of content the complete answer, but I know we have content to migrate that might have done this. |
Update from Judy: Headers should only be allowed in Usage Notes, and it should only be H3 or lower |
I will implement a check for this. |
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
The Component decorator has headings in the content for individual members of the "component interface" which do not render nicely and confuse the table of contents. See https://next.angular.io/api/core/Component#simple-example
The text was updated successfully, but these errors were encountered: