bitstarr/grav-plugin-markdown-details

Adds the ability to render collapsible sections in Markdown

grav-plugin-markdown-details's Issues

provide way to use open attribute of <details> element

Add option to disable plus/minus icons

As title says… Maybe adding a way to add custom icons? but not this outdated icon fonts crap of cause.

Error after installing

Grav version 1.6.19

E_NOTICE - Undefined property: Grav\Plugin\MarkdownDetailsPlugin::$a11y

More details in the log

make template extendable/overwritable

see title…

Review

I've taken a brief look at the plugin and would like to share my findings. Hope you may find it useful.

• Since the advent of Grav 1.7.0 things have change a bit. You might want to take a look at the upgrade docs and especially the section for developers.
  An easy upgrade approach could be to create a new plugin template using $ bin/plugin devtools new-plugin and copy your existing code into the right places.
• The events onMarkdownInitialized and onTwigSiteVariables are being handled on each and every request, also when derived from Admin. Might be a good idea to move the event registrations into onPluginsInitialized and enable them only when request is not from Admin.
• There is a dedicated event onAssetsInitialized where assets can be added.

  onAssetsInitialized
  The event indicates the assets manager has been initialized and is ready for assets to be added and managed.

• Usually, assets like js and css are stored in their respective folders /js and /css.
• Variables should be named using camelCase as commonly used in Grav.
• The use of config variables for css classes seem a bit overkill. The chances the plugin will be used in a project that already contains existing classes for summary/details etc is probably nihil. Using fixed class names might just be enough.
• Create an icon folder to store a default svg and load the svg from file. This allows users to use their own icon. Or, you could allow a config variable to contain an svg definition and load that definition.
• Variable $matches is only used in one preg_match

Hope this helps...

How to make this?

i was trying, but that isn't working

!> top layer
!> 1st header
first content
!@
!> 2nd header
2nd content
!@
!@