Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugins to mkdocs to enhance the development experience #43

Open
TOTON95 opened this issue Apr 24, 2024 · 4 comments
Open

Add plugins to mkdocs to enhance the development experience #43

TOTON95 opened this issue Apr 24, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@TOTON95
Copy link
Contributor

TOTON95 commented Apr 24, 2024

This is a list of plugins that I think would help us to maintain and create quality content for the community.

MKDocs Plugins for Aerial Robotics CWG

  1. mkdocs-click -- An MkDocs extension to generate documentation for Click command line applications.
  2. mkdocs-rss-plugin -- A plugin for MkDocs, the static site generator, which creates RSS 2.0 and JSON Feed 1.1 feeds using the creation and modification dates from git log and page metadata (YAML frontmatter).
  3. mkdocs-newsletter -- MkDocs plugin to show the changes of documentation repositories in a user friendly format, at the same time that it's easy for the authors to maintain.
  4. mkdocs-publisher -- Publisher for MkDocs is a set of plugins that helps with content creation and publication.
  5. mkdocs-pdf-export-plugin -- An MkDocs plugin to export content pages as PDF files
  6. mkdocs-with-pdf -- This plugin will generate a single PDF file from your MkDocs repository.
  7. mkdocs-exclude-search -- A mkdocs plugin that excludes selected chapters from the docs search index.
  8. mktestdocs -- Run pytest against markdown files/docstrings.
  9. mkdocs-emailprotect -- A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots
  10. mkdocs-ezglossary -- Glossary support for mkdocs.
  11. mkdocs-redirects -- Plugin for mkdocs to create page redirects (e.g. for moved/renamed pages)
  12. mkdocs-htmlproofer-plugin -- A MkDocs plugin that validates URLs, including anchors, in rendered html files.
  13. mkdocs-static-i18n -- The MkDocs plugin that helps you support multiple language versions of your site / documentation.
  14. mkdocs-git-revision-date-plugin -- MkDocs plugin that displays the last revision date of the current page of the documentation based on Git.
  15. mkdocs-git-authors-plugin -- Lightweight MkDocs plugin to display git authors of a markdown page
  16. mkdocs-git-revision-date-localized-plugin -- MkDocs plugin that enables displaying the date of the last git modification of a page.
  17. markdown-include -- This is an extension to Python-Markdown which provides an "include" function, similar to that found in LaTeX (and also the C pre-processor and Fortran).
  18. mkdocs-gitsnippet-plugin -- MkDocs plugin that allow to inject snippet or all markdown content from a given remote git repository.
@TOTON95 TOTON95 added the documentation Improvements or additions to documentation label Apr 24, 2024
@knmcguire
Copy link
Member

That's a lot of plugins! I guess we should discuss which ones will be useful but let's just go by them one by one :)

@TOTON95
Copy link
Contributor Author

TOTON95 commented Apr 25, 2024

That's a lot of plugins! I guess we should discuss which ones will be useful but let's just go by them one by one :)

@knmcguire Sure, and I already left some of those out, haha. We can even propose a priority system for these, that goes according to our needs, as consumers, writers, and developers. Maybe, we can start with the ones that create a solid base for the rest.

@knmcguire
Copy link
Member

Here is another nice catalog of different plugins here as well: https://github.com/mkdocs/catalog. It's a lot but might be a good recourse

@knmcguire
Copy link
Member

I've added this to the documentation project list

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants