{"id":15017143,"url":"https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin","last_synced_at":"2025-04-12T11:41:52.077Z","repository":{"id":227920051,"uuid":"772675515","full_name":"daxcore/mkdocs-obsidian-interactive-graph-plugin","owner":"daxcore","description":"interactive graph for Material for MkDocs like Obsidian, refer demo:","archived":false,"fork":false,"pushed_at":"2024-04-24T19:25:35.000Z","size":644,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-07T09:21:43.683Z","etag":null,"topics":["echarts","graph","interactive","mkdocs","mkdocs-material","mkdocs-plugin","mkdocs-plugins","obsidian","obsidian-md"],"latest_commit_sha":null,"homepage":"https://daxcore.github.io/mkdocs-obsidian-interactive-graph-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/daxcore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2024-03-15T17:00:19.000Z","updated_at":"2024-09-06T09:56:42.000Z","dependencies_parsed_at":"2024-03-28T13:42:50.329Z","dependency_job_id":"3b058ec3-4c05-446d-9428-095bb94a642e","html_url":"https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin","commit_stats":null,"previous_names":["daxcore/mkdocs-obsidian-interactive-graph","daxcore/mkdocs-obsidian-interactive-graph-plugin"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daxcore%2Fmkdocs-obsidian-interactive-graph-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daxcore%2Fmkdocs-obsidian-interactive-graph-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daxcore%2Fmkdocs-obsidian-interactive-graph-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daxcore%2Fmkdocs-obsidian-interactive-graph-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daxcore","download_url":"https://codeload.github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248563496,"owners_count":21125296,"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":["echarts","graph","interactive","mkdocs","mkdocs-material","mkdocs-plugin","mkdocs-plugins","obsidian","obsidian-md"],"created_at":"2024-09-24T19:49:56.758Z","updated_at":"2025-04-12T11:41:52.047Z","avatar_url":"https://github.com/daxcore.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Interactive Graph for Material for MkDocs\nPlugin for Material for MkDocs to draw an interactive graph like Obsidian.\nThe graph inside the sidebar is just available for non-mobile website. The modal view via the button next to the light/dark mode switch shall work on all devices.\n\nRefer [Github Pages](https://daxcore.github.io/mkdocs-obsidian-interactive-graph-plugin/) for a **demonstration** of the interactive graph in Material for MkDocs.\n\n[![Build Status](https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin/actions/workflows/ci.yml)\n[![PyPI Version](https://img.shields.io/pypi/v/mkdocs-obsidian-interactive-graph-plugin)](https://pypi.org/project/mkdocs-obsidian-interactive-graph-plugin/)\n[![PyPi Downloads](https://img.shields.io/pypi/dm/mkdocs-obsidian-interactive-graph-plugin.svg)](https://pypi.org/project/mkdocs-obsidian-interactive-graph-plugin/)\n[![GitHub License](https://img.shields.io/github/license/daxcore/mkdocs-obsidian-interactive-graph-plugin)](https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin/blob/main/LICENSE)\n\n# Installation\nAvailable on [PyPI](https://pypi.org/project/mkdocs-obsidian-interactive-graph-plugin/).\nInstall via `pip install mkdocs-obsidian-interactive-graph-plugin` or add it to your `requirements.txt`.\n\n# Usage\n## Setup in MkDocs\nActivate the plugin in `mkdocs.yml`, but **note** that this plugin has to be located before plugins, that replace wikilinks by markdown links. Currently just wikilinks like `[[Link#Anchor|Custom Text]]` are supported.\n```\nplugins:\n  - obsidian-interactive-graph\n\nextra_javascript:\n  - https://fastly.jsdelivr.net/npm/jquery/dist/jquery.min.js\n  - https://fastly.jsdelivr.net/npm/echarts/dist/echarts.min.js\n  - assets/javascripts/interactive_graph.js\n\nextra_css:\n  - assets/stylesheets/interactive_graph.css\n```\n\n## Graph Javascript by Apache ECharts\nA `interactive_graph.js` example can be downloaded from [here](https://raw.githubusercontent.com/daxcore/mkdocs-obsidian-interactive-graph-plugin/main/docs/ObsidianVault/assets/javascripts/interactive_graph.js) and must be located into the docs directory under `docs/YourSiteName/assets/javascripts/interactive_graph.js`.\n\nBeginning from version `0.3.0` the default graph inside the sidebar was minimized to edges related to the current page only. The previous behavior can be restored by setting `global` to `true` at line `draw_graph_sidebar(myChart, global=false)` at top of javascript file.\n\n# Docker\nAdapt the `.env` and `mkdocs.yml` files to your needs. `DEV=ON` will rebuild the `mkdocs-obsidian-interactive-graph-plugin` from local files. If `DEV != ON` the upstream packages of PyPI will be used. Build and start the Docker container via `docker compose up --build [-d]`.\n\n# References\n* https://www.mkdocs.org/\n* https://squidfunk.github.io/mkdocs-material/\n* https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main\n* https://github.com/GooRoo/mkdocs-obsidian-bridge\n* https://github.com/blueswen/mkdocs-glightbox\n* https://echarts.apache.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaxcore%2Fmkdocs-obsidian-interactive-graph-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaxcore%2Fmkdocs-obsidian-interactive-graph-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaxcore%2Fmkdocs-obsidian-interactive-graph-plugin/lists"}