{"id":25110027,"url":"https://github.com/7rikazhexde/mkdocs-macros-utils","last_synced_at":"2025-04-02T09:25:57.396Z","repository":{"id":275309750,"uuid":"925709648","full_name":"7rikazhexde/mkdocs-macros-utils","owner":"7rikazhexde","description":"mkdocs-macros-utils is mkdocs-macros-plugin based project that provides macros to extend cards, code blocks, etc, in MkDocs documents.","archived":false,"fork":false,"pushed_at":"2025-03-31T03:15:43.000Z","size":5387,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T04:23:25.614Z","etag":null,"topics":["documentation","jinja2","mkdocs","mkdocs-macros-plugin","mkdocs-material","python"],"latest_commit_sha":null,"homepage":"https://7rikazhexde.github.io/mkdocs-macros-utils/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/7rikazhexde.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-01T14:57:48.000Z","updated_at":"2025-03-31T03:12:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"d37b4af8-dc45-4025-98e4-38819ea10a23","html_url":"https://github.com/7rikazhexde/mkdocs-macros-utils","commit_stats":null,"previous_names":["7rikazhexde/mkdocs-macros-utils"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7rikazhexde%2Fmkdocs-macros-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7rikazhexde%2Fmkdocs-macros-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7rikazhexde%2Fmkdocs-macros-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7rikazhexde%2Fmkdocs-macros-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/7rikazhexde","download_url":"https://codeload.github.com/7rikazhexde/mkdocs-macros-utils/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246415711,"owners_count":20773522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","jinja2","mkdocs","mkdocs-macros-plugin","mkdocs-material","python"],"created_at":"2025-02-08T00:34:33.790Z","updated_at":"2025-04-02T09:25:57.391Z","avatar_url":"https://github.com/7rikazhexde.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-macros-utils\n\n[mkdocs-macros-utils](https://pypi.org/project/mkdocs-macros-utils/) is [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io/en/latest/) based project that provides macros to extend cards, code blocks, etc, in MkDocs documents.\n\n[![pages-build-deployment](https://github.com/7rikazhexde/mkdocs-macros-utils/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/7rikazhexde/mkdocs-macros-utils/actions/workflows/pages/pages-build-deployment) [![DOCS](https://img.shields.io/badge/Docs-Click%20Here-blue?colorA=24292e\u0026colorB=0366d6\u0026logo=github)](https://7rikazhexde.github.io/mkdocs-macros-utils/)\n\n## Features\n\n- **Link Card**: Create link cards with images and descriptions, etc\n- **Gist Code Block**: Embed and syntax-highlight code from GitHub Gists\n- **X/Twitter Card**: Embed tweets with proper styling and dark mode support\n\n## Usage\n\n### Install [mkdocs-macros-utils](https://pypi.org/project/mkdocs-macros-utils/)\n\n```bash\n# For pip\npip install mkdocs-macros-utils\n\n# For poetry\npoetry add mkdocs-macros-utils\n```\n\n### Config settings\n\n1. Add the plugin to your `mkdocs.yml`\n\n    ```yaml\n    plugins:\n      - macros:\n          modules: [mkdocs_macros_utils]\n\n    markdown_extensions:\n      - attr_list\n      - md_in_html\n\n    extra:\n      debug:\n        link_card: false  # Set to true for debug logging\n        gist_codeblock: false\n        x_twitter_card: false\n\n    extra_css:\n      - stylesheets/macros-utils/link-card.css\n      - stylesheets/macros-utils/gist-cb.css\n      - stylesheets/macros-utils/x-twitter-link-card.css\n\n    extra_javascript:\n      - javascripts/macros-utils/x-twitter-widget.js\n    ```\n\n1. Start the development server\n\n    ```bash\n    poetry run mkdocs serve\n    ```\n\nThe plugin will automatically create the required directories and copy CSS/JS files during the build process.\n\n## Documentation\n\nFor detailed usage and examples, please see the [documentation](https://7rikazhexde.github.io/mkdocs-macros-utils/).\n\n## License\n\nMIT License - see the [LICENSE](./LICENCE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F7rikazhexde%2Fmkdocs-macros-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F7rikazhexde%2Fmkdocs-macros-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F7rikazhexde%2Fmkdocs-macros-utils/lists"}