{"id":14065460,"url":"https://github.com/timvink/mkdocs-charts-plugin","last_synced_at":"2025-04-04T09:09:24.608Z","repository":{"id":40663410,"uuid":"436036257","full_name":"timvink/mkdocs-charts-plugin","owner":"timvink","description":"Mkdocs plugin to add plots from data using vegalite","archived":false,"fork":false,"pushed_at":"2024-10-22T13:38:52.000Z","size":925,"stargazers_count":84,"open_issues_count":3,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T08:09:14.649Z","etag":null,"topics":["charts","mkdocs","mkdocs-plugin","vega-lite"],"latest_commit_sha":null,"homepage":"https://timvink.github.io/mkdocs-charts-plugin/","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/timvink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["timvink"]}},"created_at":"2021-12-07T21:53:15.000Z","updated_at":"2025-02-24T18:50:05.000Z","dependencies_parsed_at":"2023-02-10T02:31:19.877Z","dependency_job_id":"694da105-8983-41cc-8106-1ad4e04fa360","html_url":"https://github.com/timvink/mkdocs-charts-plugin","commit_stats":{"total_commits":62,"total_committers":4,"mean_commits":15.5,"dds":0.08064516129032262,"last_synced_commit":"73652ecb805002d7f5081a6d5a9c04ec002d0b4d"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-charts-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-charts-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-charts-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-charts-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvink","download_url":"https://codeload.github.com/timvink/mkdocs-charts-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149502,"owners_count":20891954,"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":["charts","mkdocs","mkdocs-plugin","vega-lite"],"created_at":"2024-08-13T07:04:30.236Z","updated_at":"2025-04-04T09:09:24.582Z","avatar_url":"https://github.com/timvink.png","language":"Python","readme":"[![Actions Status](https://github.com/timvink/mkdocs-charts-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-charts-plugin/actions)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-charts-plugin)\n![PyPI](https://img.shields.io/pypi/v/mkdocs-charts-plugin)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-charts-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-charts-plugin)\n![PyPI - License](https://img.shields.io/pypi/l/mkdocs-charts-plugin)\n\n# mkdocs-charts-plugin\n\n[MkDocs](https://www.mkdocs.org/) plugin to create plots from data using the declarative [vegalite](https://vega.github.io/vega-lite/) syntax. This makes it easier to [build reproducible reports with MkDocs](https://timvink.nl/reproducible-reports-with-mkdocs/).\n\n👉 See it in action on the [demo page](https://timvink.github.io/mkdocs-charts-plugin/demo/)\n\nIncludes supports for [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme features like [instant loading](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=reload#instant-loading) and [dark color themes](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle).\n\n## Installation\n\nInstall the plugin using `pip3`:\n\n```shell\npip3 install mkdocs-charts-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n  - search\n  - charts\n\nextra_javascript:\n  - https://cdn.jsdelivr.net/npm/vega@5\n  - https://cdn.jsdelivr.net/npm/vega-lite@5\n  - https://cdn.jsdelivr.net/npm/vega-embed@6\n\nmarkdown_extensions:\n  - pymdownx.superfences:\n      custom_fences:\n        - name: vegalite\n          class: vegalite\n          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite\n```\n\n\u003e If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.\n\n## Usage\n\nYou can insert any valid [vegalite](https://vega.github.io/vega-lite/) JSON into a markdown file. But the real magic is that you can visualize `.json` or `.csv` files:\n\n````json hl_lines=\"4\"\n```vegalite \n{\n  \"description\": \"A simple bar chart with embedded data.\",\n  \"data\": {\"url\" : \"assets/charts/data/basic_bar_chart.json\"},\n  \"mark\": {\"type\": \"bar\", \"tooltip\": true},\n  \"encoding\": {\n    \"x\": {\"field\": \"a\", \"type\": \"nominal\", \"axis\": {\"labelAngle\": 0}},\n    \"y\": {\"field\": \"b\", \"type\": \"quantitative\"}\n  }\n}\n```\n````\n\nSee the [vegalite editor](https://vega.github.io/editor/#/) for a range of examples.\n\n## Documentation\n\nSee the documentation [timvink.github.io/mkdocs-charts-plugin](https://timvink.github.io/mkdocs-charts-plugin/) for examples, use cases and options.\n\nDo checkout the other [charting plugins for mkdocs](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#images-tables-charts--graphs) that might suit your specific use-case better.","funding_links":["https://github.com/sponsors/timvink"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-charts-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvink%2Fmkdocs-charts-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-charts-plugin/lists"}