Metadata-Version: 2.4
Name: zensical-macros-utils
Version: 0.1.0
Summary: zensical-macros-utils is a zensical-based project that provides macros to extend cards, code blocks, etc, in MkDocs documents.
Project-URL: homepage, https://github.com/7rikazhexde/zensical-macros-utils
Project-URL: repository, https://github.com/7rikazhexde/zensical-macros-utils
Project-URL: documentation, https://7rikazhexde.github.io/zensical-macros-utils/
Author-email: 7rikazhexde <33836132+7rikazhexde@users.noreply.github.com>
License: MIT
License-File: LICENCE
Requires-Python: >=3.10
Requires-Dist: jinja2>=3.0.0
Requires-Dist: pygments>=2.19.1
Requires-Dist: requests>=2.25.0
Requires-Dist: zensical>=0.0.41
Description-Content-Type: text/markdown

# zensical-macros-utils

[zensical-macros-utils](https://7rikazhexde.github.io/zensical-macros-utils/) is a [zensical](https://zensical.org/)-based project that provides macros to extend cards, code blocks, etc, in MkDocs documents.

[![pages-build-deployment](https://github.com/7rikazhexde/zensical-macros-utils/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/7rikazhexde/zensical-macros-utils/actions/workflows/pages/pages-build-deployment) [![DOCS](https://img.shields.io/badge/Docs-Click%20Here-blue?colorA=24292e&colorB=0366d6&logo=github)](https://7rikazhexde.github.io/zensical-macros-utils/)

## 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 `zensical-macros-utils`

```bash
# For pip
pip install zensical-macros-utils

# For uv
uv add zensical-macros-utils
```

### Config settings

1. Add the extension to your `zensical.toml`

    ```toml
    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",
    ]

    [project.plugins.macros]
    modules = ["zensical_macros_utils"]

    [project.extra.debug]
    link_card = false
    gist_codeblock = false
    x_twitter_card = false
    ```

1. Start the development server

    ```bash
    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](https://7rikazhexde.github.io/zensical-macros-utils/).

## License

MIT License - see the [LICENSE](./LICENCE) file for details.
