Missing documentation for included plugins

[eikowagenknecht]

Is your feature request related to a problem? Please describe.
I just discovered quartz yesterday. In the process of setting it up, I noticed that most of the plugins are not documented.

Yes, I can read the code to see what they do and that's great, but some additional documentation would be very welcome and make the onboarding experience easier.

Describe the solution you'd like
I would include a very short description in the plugin file itself plus a link to the website where I would include a longer description.

Describe alternatives you've considered
Just read the code.

Additional context
I could go through the existing plugins and do the documentation if the maintainer agrees and would welcome a PR for this:-)

[aarnphm]

I'm not sure what you meant here, but if you search plugins, it shows pretty much docs and locations to modify code.

Also you can Ctrl+Shift+K to search for tags, or any transclude https://quartz.jzhao.xyz/#-features should show it

[eikowagenknecht]

I was talking about this section of the config:

I was looking into using quartz to set up an experimental digital garden site for myself. It seems that a lot of the customizability comes from the plugin engine (and the ability to write own plugins and easily integrate them), so I wanted to know what the existing plugins do, to see which of them to keep, what functionality to add with own plugins and where to place it.

Of course, I can read the code to see what the plugins do. But it would be nicer, if I had a high-level abstraction for each of them easily available and I was offering to contribute such docs :-)

Regarding the official page:

If I search for "CreatedModifiedDate" for example, there are currently no hits, same for e.g. Plugin.Description, Plugin.AliasRedirects etc. :

The code itself also contains no high-level abstract of what the plugin does:

For some, there is documentation already:

I was thinking of adding a page that lists all Plugins with a short description of what it does and how to configure it (or where already available a link to the existing documentation).

[jackyzha0]

You're free to contribute docs! A lot of these were added as the codebase grew but we obviously missed a few spots :) Would welcome contributions here (anything with a parent tag of plugin ends up in https://quartz.jzhao.xyz/tags/plugin)

[eikowagenknecht]

Great, I'll look into it in the next days :-)

[jackyzha0]

Closed in #888 :) thanks again