{"library":"neoteroi-mkdocs","title":"Neoteroi MkDocs Plugins","description":"neoteroi-mkdocs provides a collection of plugins for MkDocs and Python Markdown, enhancing documentation sites with features like cards, contributors lists, timelines, Gantt charts, and OpenAPI specification integration. Currently at version 1.2.0, the library maintains an active development pace with regular updates and feature additions.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install neoteroi-mkdocs"],"cli":null},"imports":["from neoteroi_mkdocs.plugins import CardsPlugin"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"mkdir my-docs\ncd my-docs\n\n# Create mkdocs.yml\ncat <<EOF > mkdocs.yml\nsite_name: My Awesome Docs\n\nplugins:\n  - neoteroi.cards\n  - neoteroi.contribs\n\n# Add some content\nEOF\n\nmkdir docs\ncat <<EOF > docs/index.md\n# Welcome to My Docs\n\nThis is a sample page using neoteroi-mkdocs plugins.\n\n<div class=\"cards\">\n  <div class=\"card\">\n    <h3>Feature One</h3>\n    <p>Description for feature one.</p>\n  </div>\n  <div class=\"card\">\n    <h3>Feature Two</h3>\n    <p>Description for feature two.</p>\n  </div>\n</div>\n\n\n<div class=\"contribs\"></div>\nEOF\n\n# Run MkDocs development server\nmkdocs serve","lang":"bash","description":"This quickstart demonstrates how to set up a basic MkDocs project and enable two common neoteroi-mkdocs plugins: `cards` and `contribs`. It creates `mkdocs.yml` to configure the plugins and `docs/index.md` with example usage of their respective HTML/Markdown syntax. Finally, it starts the MkDocs development server to view the output.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}