{"id":13929593,"url":"https://github.com/MaxvdKolk/vimwikigraph","last_synced_at":"2025-07-19T11:32:26.364Z","repository":{"id":50249471,"uuid":"268059643","full_name":"MaxvdKolk/vimwikigraph","owner":"MaxvdKolk","description":"vimwikigraph - visualise vimwiki links using the graphviz dot language ","archived":false,"fork":false,"pushed_at":"2021-05-31T11:42:50.000Z","size":368,"stargazers_count":53,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-08T18:24:02.035Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/MaxvdKolk.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}},"created_at":"2020-05-30T10:44:58.000Z","updated_at":"2024-04-29T18:21:26.000Z","dependencies_parsed_at":"2022-08-25T19:01:53.324Z","dependency_job_id":null,"html_url":"https://github.com/MaxvdKolk/vimwikigraph","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxvdKolk%2Fvimwikigraph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxvdKolk%2Fvimwikigraph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxvdKolk%2Fvimwikigraph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxvdKolk%2Fvimwikigraph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaxvdKolk","download_url":"https://codeload.github.com/MaxvdKolk/vimwikigraph/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226597747,"owners_count":17657205,"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":[],"created_at":"2024-08-07T18:02:26.293Z","updated_at":"2024-11-26T18:30:56.336Z","avatar_url":"https://github.com/MaxvdKolk.png","language":"Go","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# vimwikigraph\n\n![Go](https://github.com/MaxvdKolk/vimwikigraph/workflows/Go/badge.svg)\n\n`vimwikigraph` walks all files in a\n[vimwiki](https://github.com/vimwiki/vimwiki) directory and builds a\ngraph between the encountered files and their internal references. The\ncode supports vimwiki-style links `[[link]]`, `[[link|description]]`\nand markdown-style links `[description](link)`. The graph is\nconverted to the DOT language\nusing [`dot`](https://github.com/emicklei/dot). The results can then be\nvisualised with [graphviz](https://www.graphviz.org/about/), e.g. using\n`dot`, `neato`, `fdp`, etc.\n\nThe graph visualises your notes and their connections, possibly\nproviding new insights.\n\n## Usage\n\n```\n./vimwikigraph $HOME/vimwiki | dot -Tpng \u003e test.png \u0026\u0026 open test.png\n```\n\n`-diary`: collapse all diary entries under a single node `diary.wiki`\n\n`-cluster`: cluster subdirectories as subgraphs\n\n`-l`: only nodes with at least `l` edges are inserted. The inserted nodes are\ninserted with all their edges. Thus, nodes with less than `l` edges can appear\nwhen they are connected to other nodes that do satisfy the requirement.\nFor `-l 0`, all nodes are inserted.\n\n`--ignore REGEX`: ignores any encountered path matching `REGEX`\n\nNote: any trailing argument are considered directories to be skipped.\n\n## Examples\n\nTo illustrate `/example/` contains some `.wiki` files and also a\ndiary, `/example/diary/*.wiki`. Running `vimwikigraph` produces the\nfollowing output. All `diary` files are collapse by default into a\nsingle node. Any connections to and from any diary files are simply\nan arrow point in to, or out of, the diary.\n\n```\n./vimwikigraph example | dot -Tpng \u003e example.png\n```\n\n![](./doc/example.png)\n\nThe `-diary` flag ensures all diary items are shown as nodes.\n\n```\n./vimwikigraph example -diary | dot -Tpng \u003e example.png\n```\n\n![](./doc/example_diary.png)\n\nThe `-cluster` flag adds all diary items to a subgraph.\n\n```\n./vimwikigraph example -diary -cluster | dot -Tpng \u003e example.png\n```\n\n![](./doc/example_diary_cluster.png)\n\nThe `--ignore` allows to filter files by the given regex, e.g. to ignore\nany matches with `alice` or `bob`\n\n```\n./vimwikigraph example -diary -cluster --ignore \"alice|bob\" | dot -Tpng \u003e example.png\n```\n\n![](./doc/example_ignore_alice_or_bob.png)\n\n## Installation\n\n```\ngo get github.com/maxvdkolk/vimwikigraph\n```\n\n## Change log\n\n- 2021/05/31: add `--ignore` flag to ignore any path that matches the provided\n  regex.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMaxvdKolk%2Fvimwikigraph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMaxvdKolk%2Fvimwikigraph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMaxvdKolk%2Fvimwikigraph/lists"}