Title: Create a `max-heading-level` rule · Issue #86 · github/markdownlint-github · GitHub
Open Graph Title: Create a `max-heading-level` rule · Issue #86 · github/markdownlint-github
X Title: Create a `max-heading-level` rule · Issue #86 · github/markdownlint-github
Description: When Markdown content is rendered on GitHub, it is rendered into the context of a webpage. This means there is already an external heading structure to contend with. In issue and PR comments, the maximum heading level that should be used...
Open Graph Description: When Markdown content is rendered on GitHub, it is rendered into the context of a webpage. This means there is already an external heading structure to contend with. In issue and PR comments, the m...
X Description: When Markdown content is rendered on GitHub, it is rendered into the context of a webpage. This means there is already an external heading structure to contend with. In issue and PR comments, the m...
Opengraph URL: https://github.com/github/markdownlint-github/issues/86
X: @github
Domain: patch-diff.githubusercontent.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Create a `max-heading-level` rule","articleBody":"When Markdown content is rendered on GitHub, it is rendered into the context of a webpage. This means there is already an external heading structure to contend with.\n\nIn issue and PR comments, the maximum heading level that should be used is 3 (`###`). In files in Code View, the maximum should be 2 (`##`).\n\nI think it's debatable whether Markdown files should be written with their intended viewing location in mind - Markdown is supposed to be a rendering-agnostic markup format. But comments should probably always be written like this. So I think it would be useful to make a new rule available, but **disable it by default**.\n\nI propose we make this generic, allowing the linter to customize the heading level for the situation. For example, the following configuration would be for comments on github.com:\n\n```js\n{\n \"max-heading-level\": {\n \"level\": 3\n }\n}\n```\n\nRelated:\n\n- https://github.com/iansan5653/github-markdown-a11y-extension/issues/14","author":{"url":"https://github.com/iansan5653","@type":"Person","name":"iansan5653"},"datePublished":"2023-10-06T15:36:50.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/86/markdownlint-github/issues/86"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:529e1d1c-365f-09be-6f3d-2436feef3a8d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B4D8:26870:21273D:2AF2D1:698E7BC8 |
| html-safe-nonce | 86b7d42f66aa551302ed99ae24d8c19118813e2b0e77a7efb9656377905ca6a6 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNEQ4OjI2ODcwOjIxMjczRDoyQUYyRDE6Njk4RTdCQzgiLCJ2aXNpdG9yX2lkIjoiNTkzOTUwNzg0ODc1MjgyMzI0MCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 388ee0c897237aeaac990d0d801f6bc40e82e520c0e1db57a1f7b3e9a5e683f5 |
| hovercard-subject-tag | issue:1930457324 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/github/markdownlint-github/86/issue_layout |
| twitter:image | https://opengraph.githubassets.com/fed00efdf9225cff1b23c80c509644bf90fdbb0a219540cddf89c50785da8a40/github/markdownlint-github/issues/86 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/fed00efdf9225cff1b23c80c509644bf90fdbb0a219540cddf89c50785da8a40/github/markdownlint-github/issues/86 |
| og:image:alt | When Markdown content is rendered on GitHub, it is rendered into the context of a webpage. This means there is already an external heading structure to contend with. In issue and PR comments, the m... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | iansan5653 |
| hostname | github.com |
| expected-hostname | github.com |
| None | cb2828a801ee6b7be618f3ac76fbf55def35bbc30f053a9c41bf90210b8b72ba |
| turbo-cache-control | no-preview |
| go-import | github.com/github/markdownlint-github git https://github.com/github/markdownlint-github.git |
| octolytics-dimension-user_id | 9919 |
| octolytics-dimension-user_login | github |
| octolytics-dimension-repository_id | 518744654 |
| octolytics-dimension-repository_nwo | github/markdownlint-github |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 518744654 |
| octolytics-dimension-repository_network_root_nwo | github/markdownlint-github |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | f7a12861f7011eecb14bcc4388a767d829a52dfc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width