{"id":19621322,"url":"https://github.com/commenthol/markdown-it-admon","last_synced_at":"2025-02-26T18:46:03.895Z","repository":{"id":66111674,"uuid":"382383992","full_name":"commenthol/markdown-it-admon","owner":"commenthol","description":"Plugin to create admonitions for markdown-it markdown parser","archived":false,"fork":false,"pushed_at":"2023-12-29T08:45:18.000Z","size":186,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-09T14:15:31.874Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/commenthol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2021-07-02T15:12:37.000Z","updated_at":"2025-01-21T04:36:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"0cd51da1-d6b8-4861-be9b-dd016e820096","html_url":"https://github.com/commenthol/markdown-it-admon","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"73ba64e4379fc060f7509cfd3ecea08896c59c29"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmarkdown-it-admon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmarkdown-it-admon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmarkdown-it-admon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmarkdown-it-admon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commenthol","download_url":"https://codeload.github.com/commenthol/markdown-it-admon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240914943,"owners_count":19878068,"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-11T11:22:21.743Z","updated_at":"2025-02-26T18:46:03.246Z","avatar_url":"https://github.com/commenthol.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-it-admon\n\n\u003e Plugin for creating admonitions for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.\n\nWith this plugin you can create admonitions like:\n\n```\n!!! warning\n    *here be dragons*\n\n```\n\nMarkdown syntax follows [python-markdown][].\n\n[rST][] suggests the following \"types\": `attention`, `caution`, `danger`, `error`, `hint`, `important`, `note`, `tip`, and `warning`; however, you’re free to use whatever you want.\n\nA styles file does support the following admonition types: Credits go to [vscode-markdown-extended][].\n\n```\n'note',\n'summary', 'abstract', 'tldr',\n'info', 'todo',\n'tip', 'hint',\n'success', 'check', 'done',\n'question', 'help', 'faq',\n'warning', 'attention', 'caution',\n'failure', 'fail', 'missing',\n'danger', 'error', 'bug',\n'example', 'snippet',\n'quote', 'cite'\n```\n\n![](./docs/admonition-types.png)\n\n## Installation\n\nnode.js:\n\n```bash\n$ npm install markdown-it-admon --save\n```\n\n\n## API\n\n```js\nconst md = require('markdown-it')()\n             .use(require('markdown-it-admon') [, options]);\n```\n\nParams:\n\n- __name__ - container name (mandatory)\n- __options?:__\n  - __render__ - optional, renderer function for opening/closing tokens.\n\n\n## License\n\n[MIT](./LICENSE)\n\n\n## References\n\n\u003c!-- !ref --\u003e\n\n* [python-markdown][python-markdown]\n* [rST][rST]\n* [vscode-markdown-extended][vscode-markdown-extended]\n\n\u003c!-- ref! --\u003e\n\n[python-markdown]: https://python-markdown.github.io/extensions/admonition/\n\n[rST]: https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions\n\n[vscode-markdown-extended]: https://github.com/qjebbs/vscode-markdown-extended\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommenthol%2Fmarkdown-it-admon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommenthol%2Fmarkdown-it-admon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommenthol%2Fmarkdown-it-admon/lists"}