mkdocs-macros-utils

Deprecated: This package is no longer maintained. Please migrate to zensical-macros-utils instead.

mkdocs-macros-utils is a zensical-based project that provides macros to extend cards, code blocks, etc, in MkDocs documents.

Features

• Link Card: Create link cards with images and descriptions, etc
• Gist Code Block: Embed and syntax-highlight code from GitHub Gists
• X/Twitter Card: Embed tweets with proper styling and dark mode support

Usage

Install mkdocs-macros-utils

# For pip
pip install mkdocs-macros-utils

# For uv
uv add mkdocs-macros-utils

Config settings

1. Add the extension to your mkdocs.yml

   markdown_extensions:
     - zensical.extensions.macros:
         modules: [mkdocs_macros_utils]
   
   extra:
     debug:
       link_card: false  # Set to true for debug logging
       gist_codeblock: false
       x_twitter_card: false
   
   extra_css:
     - stylesheets/macros-utils/link-card.css
     - stylesheets/macros-utils/gist-cb.css
     - stylesheets/macros-utils/x-twitter-link-card.css
   
   extra_javascript:
     - javascripts/macros-utils/x-twitter-widget.js
   

2. Start the development server

   uv run zensical serve
   

The plugin will automatically create the required directories and copy CSS/JS files during the build process.

Documentation

For detailed usage and examples, please see the documentation.

License

MIT License - see the LICENSE file for details.