catalog icon indicating copy to clipboard operation
catalog copied to clipboard

Add project: mkdocs-snippets

Open SaltyAimbOtter opened this issue 1 year ago • 3 comments

What kind of change does this PR introduce?

  • [X] Add a project
  • [ ] Update a project
  • [ ] Remove a project
  • [ ] Add or update a category
  • [ ] Change configuration
  • [ ] Documentation
  • [ ] Other, please describe:

Description:

I added the snippet plugin I wrote a while back for another project. It has a few cool features and I hope more people will reuse it if it is listed here.

Checklist:

  • [X] I have read the CONTRIBUTING guidelines.
  • [X] I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

SaltyAimbOtter avatar Aug 17 '24 18:08 SaltyAimbOtter

CI fail cause:

 mkdocs-snippets:
     'plugin' label should be present if and only if 'mkdocs_plugin:'    

What's the matter the mkdocs_plugin? It is not documented in the CONTRIBUTING.md

SaltyAimbOtter avatar Aug 17 '24 19:08 SaltyAimbOtter

@SaltyAimbOtter if you look at other projects above, you'll see they specify a mkdocs_plugin key-value pair. It's the name of the plugin, as specified in mkdocs.yml under the plugins configuration item. Sorry the contribution guide doesn't mention it, I believe it's the original CONTRIBUTING file from the repo we forked, and we didn't update it with our customizations.

pawamoy avatar Aug 18 '24 10:08 pawamoy

@SaltyAimbOtter still interested in these PRs? :slightly_smiling_face:

pawamoy avatar Oct 10 '24 19:10 pawamoy