https://github.com/lin-stephanie/remark-directive-sugar

Provide predefined directives for image captions, video embedding, GitHub links, badges...
https://github.com/lin-stephanie/remark-directive-sugar

badge github-links image-caption markdown mdx remark-directive remark-plugin

Last synced: 11 days ago
JSON representation

Provide predefined directives for image captions, video embedding, GitHub links, badges...

• Host: GitHub
• URL: https://github.com/lin-stephanie/remark-directive-sugar
• Owner: lin-stephanie
• License: mit
• Created: 2024-10-09T15:18:16.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-01T02:03:56.000Z (about 1 month ago)
• Last Synced: 2024-12-24T19:14:08.312Z (18 days ago)
• Topics: badge, github-links, image-caption, markdown, mdx, remark-directive, remark-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/remark-directive-sugar
• Size: 169 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-directive-sugar

[![codecov][coverage-badge]][coverage]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![jsDocs.io][jsdocs-src]][jsdocs-href]

A [remark](https://github.com/remarkjs/remark) plugin built on remark-directive, providing predefined directives for image captions, video embedding, styled GitHub links, badges, and more.

## Usage

[See how to use it](https://astro-antfustyle-theme.vercel.app/blog/markdown-mdx-extended-features/#image-figure), where the styles need to be custom written and added.

The basic functionality has been implemented, but it's still a work in progress.

## Contribution

If you see any errors or room for improvement on this plugin, feel free to open an [issues](https://github.com/lin-stephanie/rehype-callouts/issues) or [pull request](https://github.com/lin-stephanie/rehype-callouts/pulls) . Thank you in advance for contributing!

## License

[MIT](https://github.com/lin-stephanie/remark-directive-sugar/blob/main/LICENSE) © 2024-PRESENT [Stephanie Lin](https://github.com/lin-stephanie)

[coverage-badge]: https://img.shields.io/codecov/c/github/lin-stephanie/remark-directive-sugar?style=flat&colorA=080f12&colorB=ef7575

[coverage]: https://codecov.io/github/lin-stephanie/remark-directive-sugar

[npm-downloads-src]: https://img.shields.io/npm/dm/remark-directive-sugar?style=flat&colorA=080f12&colorB=ef7575

[npm-downloads-href]: https://npmjs.com/package/remark-directive-sugar

[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=ef7575

[jsdocs-href]: https://www.jsdocs.io/package/remark-directive-sugar