{"id":13566727,"url":"https://github.com/EFanZh/Graphviz-Preview","last_synced_at":"2025-04-04T00:32:07.080Z","repository":{"id":22931904,"uuid":"97364107","full_name":"EFanZh/Graphviz-Preview","owner":"EFanZh","description":"Extension for Visual Studio Code to preview Graphviz (DOT) files.","archived":false,"fork":false,"pushed_at":"2025-03-08T04:26:38.000Z","size":1245,"stargazers_count":69,"open_issues_count":6,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-08T04:27:29.381Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=EFanZh.graphviz-preview","language":"TypeScript","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/EFanZh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2017-07-16T06:15:44.000Z","updated_at":"2025-03-08T03:59:10.000Z","dependencies_parsed_at":"2022-08-07T10:16:26.138Z","dependency_job_id":"6300d178-e33c-4f43-ae3e-02afbf222ab7","html_url":"https://github.com/EFanZh/Graphviz-Preview","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFanZh%2FGraphviz-Preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFanZh%2FGraphviz-Preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFanZh%2FGraphviz-Preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EFanZh%2FGraphviz-Preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EFanZh","download_url":"https://codeload.github.com/EFanZh/Graphviz-Preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247103290,"owners_count":20884023,"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-01T13:02:15.403Z","updated_at":"2025-04-04T00:32:06.709Z","avatar_url":"https://github.com/EFanZh.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Graphviz Preview\n\n[![CI](https://github.com/EFanZh/Graphviz-Preview/actions/workflows/CI.yml/badge.svg)](https://github.com/EFanZh/Graphviz-Preview/actions/workflows/CI.yml)\n[![Codecov](https://codecov.io/gh/EFanZh/Graphviz-Preview/branch/master/graph/badge.svg)](https://app.codecov.io/gh/EFanZh/Graphviz-Preview)\n\nAn extension for Visual Studio Code to preview Graphviz (DOT) files.\n\n![Graphviz Preview screenshot](resources/screenshot.png)\n\n## Installation\n\nYou can install this extension from the\n[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=EFanZh.graphviz-preview).\n\nThis extension requires [Graphviz](https://graphviz.org/) to be installed. Also, make sure that the extension can find\nthe `dot` executable provided by Graphviz. Either make sure the directory containing the `dot` executable exists in the\n`PATH` or `Path` environment variable, or specify the path of the `dot` executable with `graphvizPreview.dotPath`\nconfiguration.\n\n## Usage\n\n### Open preview\n\nOpen the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (usually by\npressing `Ctrl` + `Shift` + `P`), then select “Graphviz: Open Preview to the Side”.\n\n### Manipulate preview\n\n| Action                 | Gesture                                                               |\n| ---------------------- | --------------------------------------------------------------------- |\n| Previous graph         | `P`                                                                   |\n| Next graph             | `N`                                                                   |\n| Zoom in                | Mouse wheel up / `+`                                                  |\n| Zoom out               | Mouse wheel down / `-`                                                |\n| Toggle center position | `X`                                                                   |\n| Toggle 100% scale      | Mouse double click / `Space` / `0`                                    |\n| Scroll                 | Mouse drag / `Left` / `Right` / `Up` / `Down` / `A` / `D` / `W` / `S` |\n\nThere are three scale modes: **Fixed**, **Fit** and **Auto Fit**.\n\n- **Fixed**: The scale ratio does not change when the source changes or the window size changes.\n- **Fit**: The graph is scaled to align to the border of the visible view area.\n- **Auto Fit**: When the view area is big enough to contain a 100% sized graph, the graph will be set a scale ratio of\n  100%, otherwise the graph is scaled to fit into the view area.\n\n### Export graph\n\nTo export the generated graph, click the “Export” button on the top right corner.\n\n## Configuration\n\n| Configuration                  | Type       | Description                                                              |\n| ------------------------------ | ---------- | ------------------------------------------------------------------------ |\n| `graphvizPreview.dotPath`      | `string`   | Path to the `dot` executable.                                            |\n| `graphvizPreview.dotExtraArgs` | `string[]` | Extra arguments passed to the `dot` executable.                          |\n| `graphvizPreview.engine`       | `string`   | The layout engine to use. Currently, only the `dot` engine is supported. |\n\nMake sure the extension can find the `dot` program. You can set `graphvizPreview.dotPath` option to the path of the dot\nexecutable, or make sure the directory containing the dot program is in your `PATH` environment variable.\n\nTo set the `graphvizPreview.dotPath` option, go to File → Preference → Settings.\n\n## Known issues\n\n- After saving an untitled file, the preview becomes invalid.\n- When the scale ratio is too large, the graph may be at a wrong position.\n- Exporting only works for documents that contains a single graph.\n\n## FAQ\n\n- Q: How do I change the layout engine?\n  - A: Set `graphvizPreview.dotExtraArgs` configuration to `[\"-Glayout=\u003cENGINE\u003e\"]`, where `\u003cENGINE\u003e` is the desired\n    layout engine.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEFanZh%2FGraphviz-Preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEFanZh%2FGraphviz-Preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEFanZh%2FGraphviz-Preview/lists"}