{"id":20612099,"url":"https://github.com/aepfli/markdownlint-rule-github-admonition","last_synced_at":"2025-06-28T23:32:39.451Z","repository":{"id":132278753,"uuid":"611918590","full_name":"aepfli/markdownlint-rule-github-admonition","owner":"aepfli","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-09T20:46:42.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T18:16:54.544Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aepfli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-09T20:13:15.000Z","updated_at":"2023-03-09T20:13:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"84c862f0-aff8-462e-b399-850d44826830","html_url":"https://github.com/aepfli/markdownlint-rule-github-admonition","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"aepfli/markdownlint-rule-template","purl":"pkg:github/aepfli/markdownlint-rule-github-admonition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aepfli%2Fmarkdownlint-rule-github-admonition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aepfli%2Fmarkdownlint-rule-github-admonition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aepfli%2Fmarkdownlint-rule-github-admonition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aepfli%2Fmarkdownlint-rule-github-admonition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aepfli","download_url":"https://codeload.github.com/aepfli/markdownlint-rule-github-admonition/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aepfli%2Fmarkdownlint-rule-github-admonition/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262513625,"owners_count":23322661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T10:23:17.735Z","updated_at":"2025-06-28T23:32:39.423Z","avatar_url":"https://github.com/aepfli.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdownlint-rule-github-admonition\n\nEnsure proper GitHub admonition.\n\n## Overview\n\nEnsure nicely rendered Warnings and Notes for your markdown files.\n\n## Installation\n\nUse following command to install\n\n```console\n# TODO\nnpm install markdownlint-rule-github-admonition --save-dev\n```\n\n## Configuration\n\nRulename: `github-admonition`\n\nTags: `admonition`\n\nParameters:\n\n* `admonitions`: admonitions we should check for (`string[]`,\n  default `[ \"Note\", \"Warning\" ]`)\n* `admonitionStart`: the usual starting string for admonition (`string`,\n  default `\"\u003e **\"`)\n* `admonitionEnd`: the usual ending string for admonition (`string`,\n  default `\"**\"`)\n\nFaulty:\n\n```markdown\n\u003e **NOTE:** this will be detected{github-admonition}\n\n\u003e **NOTE:**{github-admonition}\nthis will be detected\n\n\u003e **NOTE:**{github-admonition}\n\u003e this will be detected\n\n**NOTE:** this will be detected{github-admonition}\n\n**NOTE** this will be detected{github-admonition}\n\n\u003e **NOTE** this will be detected{github-admonition}\n\n( **NOTE:** this will be detected){github-admonition}\n\n(**NOTE:** this will be detected){github-admonition}\n```\n\nCorrect:\n\n```markdown\n\u003e **Note** this is the correct syntax\n\n\u003e **Note**\n\u003e this is the correct syntax\n```\n\n### rendered comparison\n\n\u003c!-- markdownlint-disable --\u003e\n**NOTE** this will be detected{github-admonition}\n\n**NOTE this will be detected{github-admonition}**\n\n\u003e **NOTE** this will be detected{github-admonition}\n\n( **NOTE:** this will be detected){github-admonition}\n\n\u003e **Note** this is the correct syntax\n\n\u003c!-- markdownlint-enable --\u003e\n## Usage\n\nFor usage with certain tools,\nplease refer to the documentation of [markdownlint](https://github.com/davidAnson/markdownlint),\nmarkdownlint-cli or the tool you are planning to use.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faepfli%2Fmarkdownlint-rule-github-admonition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faepfli%2Fmarkdownlint-rule-github-admonition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faepfli%2Fmarkdownlint-rule-github-admonition/lists"}