search

Microflash / remark-callout-directives

Remark plugin to render callouts and admonitions with directives
MIT License
13 stars 2 forks source link

Acknowledgement and suggestion #1

Open tisonkun opened 4 months ago

tisonkun commented 4 months ago

Hi @naiyerasif!

Thank you so much that this lib satisfies my requirements perfectly!

I'm building a blog with Astro, MDX and now including this lib. Once the blog is online, I'll share a link here.

Two suggestions here:

  1. The document lacks a bit about how to apply themes. I spend a few time to understand that the index.js is the options that I should pass to the plugin function in the way how the framework does it. And the CSS should be imported or copied to the final CSS file.
  2. All the three preset themes absolutely meet their style. However, I may be more familiar with Docusaurus' Admonitions. I'd appreciate it if you can think of bundling this theme, but it's somewhat a request so you make the decision :D
tisonkun commented 4 months ago

Once the blog is online, I'll share a link here.

Here is my repo - https://github.com/tisonkun/dacapo/blob/e224b4c4fd45b0261a3ff9602f15c55417c0d051/astro.config.mjs#L19-L33

naiyerasif commented 4 months ago
  1. The document lacks a bit about how to apply themes. I spend a few time to understand that the index.js is the options that I should pass to the plugin function in the way how the framework does it. And the CSS should be imported or copied to the final CSS file.

Yes, I admit that documentation might be a bit lacking. I'm planning to create a new release with some additional information on how to use themes. If you'd like to improve something specific, please create a PR with your suggested improvements.

  1. All the three preset themes absolutely meet their style. However, I may be more familiar with Docusaurus' Admonitions.

I removed Docusaurus' Infima theme with v4 of this plugin. I wanted to ship just enough themes to demonstrate the possibilities with this plugin, and let people remix their own themes.

I'd appreciate it if you can think of bundling this theme, but it's somewhat a request so you make the decision :D

I have created a dedicated repository where you can play with Infima theme using GitHub Codespaces. Try it out and see if this works for you.

Open in GitHub Codespaces