{"id":13625246,"url":"https://github.com/dzylikecode/VSCodeExt-docsify-Preview","last_synced_at":"2025-04-16T06:32:09.352Z","repository":{"id":61145252,"uuid":"546125733","full_name":"dzylikecode/VSCodeExt-docsify-Preview","owner":"dzylikecode","description":"write docsify elegantly in VSCode ","archived":false,"fork":false,"pushed_at":"2022-11-11T08:20:48.000Z","size":3865,"stargazers_count":4,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-01T22:04:39.113Z","etag":null,"topics":["docsify","docsify-preview","extension","markdown","markdown-preview","visual-studio-code","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=dzylikecode.docsify-preview","language":"JavaScript","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/dzylikecode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-05T15:10:27.000Z","updated_at":"2023-06-12T08:46:24.000Z","dependencies_parsed_at":"2022-10-11T18:17:53.798Z","dependency_job_id":null,"html_url":"https://github.com/dzylikecode/VSCodeExt-docsify-Preview","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/dzylikecode%2FVSCodeExt-docsify-Preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzylikecode%2FVSCodeExt-docsify-Preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzylikecode%2FVSCodeExt-docsify-Preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzylikecode%2FVSCodeExt-docsify-Preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dzylikecode","download_url":"https://codeload.github.com/dzylikecode/VSCodeExt-docsify-Preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223700318,"owners_count":17188297,"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":["docsify","docsify-preview","extension","markdown","markdown-preview","visual-studio-code","vscode","vscode-extension"],"created_at":"2024-08-01T21:01:53.058Z","updated_at":"2024-11-08T14:30:51.253Z","avatar_url":"https://github.com/dzylikecode.png","language":"JavaScript","funding_links":["https://www.paypal.com/paypalme/dzylikecode"],"categories":["markdown","visual-studio-code"],"sub_categories":[],"readme":"# Docsify Preview\n\n- market: https://marketplace.visualstudio.com/items?itemName=dzylikecode.docsify-preview\n- online docs: https://dzylikecode.github.io/VSCodeExt-docsify-Preview/#/\n\n[Docsify](https://docsify.js.org/#/) is a magical documentation site generator. What the plugin does is help you see the preview of your markdown file when writing it so that you can get better feedback. What you see is what you get.\n\n## Features\n\n- preview Docsify in the sidebar\n\n  ![](assets/feature/preview.gif)\n\n- auto scroll when markdown file scrolled\n\n  ![](assets/feature/scroll-sync.gif)\n\n- auto jump to the corresponding position when opening a markdown file\n\n  ![](assets/feature/jump.gif)\n\n- auto-reload when the markdown file saved\n\n  ![](assets/feature/reload.gif)\n\n- preview: context menu\n\n  - Open in browser\n\n  - go here\n\n    ![](assets/feature/go-here.gif)\n\n  - open develop tools\n\n    ![](assets/2022-10-20-10-22-01.png)\n\n    \u003e the hint to find your source file in the developer tools\n\n  - close preview\n\n- editor: context menu\n\n  - docsify: open/close the side preview\n  - docsify: open the full preview\n\nIf you are interested in my Docsify template, welcome to visit my [Docsify-template](https://dzylikecode.github.io/#/blog/docsify/?id=template) or fork this [repo](https://github.com/dzylikecode/template-docsify), which supports mindmap, math formula, mermaid, jsRunkit, and so on.\n\nIf you want to paste images in markdown, welcome to use my other plugin:[md-paste-enhanced](https://marketplace.visualstudio.com/items?itemName=dzylikecode.md-paste-enhanced).\n\n\u003e If you like this plugin, please give me a star. Thanks!\n\n## Extension Settings\n\n- `docsifyPreview.port`: number\n\n  Set the port of the server\n\n  - the default value is `10812`\n\n- `docsifyPreview.indexFile`: string\n\n  Set the path of your custom `index.html`\n\n  To change the path, use `/` refer to the relative path from the workspace.\n\n  - Example: `/index.html`\n\n  - the default value is `/docs/index.html`\n\n- `docsifyPreview.followLinkWithCtrl`: boolean\n\n  Set whether to open the link with `Ctrl` pressed\n\n  - the default value is `false`\n\n## Shortcuts\n\n- `Ctrl+Shift+A`: open/close the side preview\n- `Ctrl+Shift+V`: open the full preview\n\n## skills\n\n- full preview (`Ctrl+Shift+V`) =\u003e open the markdown from the preview (`go Here`) =\u003e show the markdown to the side (`Ctrl+Shift+A`)\n- close the full preview (`Ctrl+W`)\n\n## Known Issues\n\nYou may open the duplicate tab in the browser if clicking the external link.\n\nIf you find any issues, please report them to [issue](https://github.com/dzylikecode/VSCodeExt-docsify-Preview/issues)\n\n## Release Notes\n\n### 1.7.0\n\n- refactor the code\n- +:shortcut `ctrl+alt+a`: open/close the side preview\n- +:shortcut `ctrl+alt+v`: open the full preview\n- follow the link with `ctrl` pressed\n\n  this may help you get rid of the annoying popup window if enabled\n\n### 1.6.0\n\nfixed: failed to open an external link\n\n\u003e Now you can open the external link in the preview, and then it will be opened in the browser. But the problem is that you may open the duplicate tab in the browser. I will try to fix it in the future.\n\n### 1.5.0\n\n- feature:\n\n  - the context menu of the preview\n\n    - add: close preview\n\n    - right-click the button will trigger the same event as clicking it.\n\n  - the context menu of the editor\n\n    - add: show Docsify preview to the side\n\n- fix:\n\n  prevent the origin context menu when right-clicking the context menu\n\n### 1.4.0\n\n- feature:\n\n  - context menu\n\n    open develop tools\n\n### 1.3.0\n\n- fix:\n\n  - need to reload the VSCode if the `index.html` is changed\n\n    now, you can just reopen the Docsify-Preview to make it work\n\n- change\n\n  pretty context menu\n\n### 1.2.0\n\nfix: issue\n\nsee more detail at https://github.com/dzylikecode/VSCodeExt-docsify-Preview/pull/11\n\n### 1.1.0\n\n- fix:\n\n  - open in browser\n\n    it will open the wrong link if you change the page in the preview\n\n  - the title doesn't respond when you change the page in the preview\n\n- refactor code\n\n### 1.0.0\n\n🎉 🎉 🎉\n\n- [x] fix: the scroll position will be put at the wrong position when opening the `Docsify Preview` the first time\n- [x] change: use the context menu to open the preview in a browser instead of right-clicking\n- [x] add: the button \"go here\" in the context menu\n\n  If you click the button, the VSCode will open the corresponding markdown and scroll to the same position.\n\n- [x] fix: the state of whether the sidebar is closed will be reset if you reload the window\n\n### 0.2.2\n\n@paulhibbitts\n\nfix: An annoying bug is that you have to drag the next markdown to the sidebar to see the preview.\n\n### 0.2.1\n\nchange the label of the menu to \"Show Docsify preview to the side\"\n\n\u003e Thanks to @paulhibbitts\n\n### 0.2.0\n\nfeature: right-click the preview will open the preview in the default browser\n\n### 0.1.0\n\nfeature: add input box if the configuration is not correct\n\n### 0.0.1\n\ncongratulations!\n\n- [x] scroll sync\n- [x] reload automatically when saving markdown\n- [x] jump to the corresponding link automatically when switching the markdown\n\n## buy me a coffee :coffee:\n\nI'm a student from China and I sacrificed the entire National Day holiday to write this plugin(Not only that, but I also overdrawn five days of study😰). If you like this plugin, please give me a star. If you want to buy me a coffee, scan the QR code below. Thanks! 😝 😝 😝\n\n|                           PayPal                           |            WeChat Pay            |            Alipay             |\n| :--------------------------------------------------------: | :------------------------------: | :---------------------------: |\n| [dzylikecode](https://www.paypal.com/paypalme/dzylikecode) | ![](assets/afford/WeChatPay.png) | ![](assets/afford/AliPay.jpg) |\n\n## backers\n\nThank you very much!!!\n\n@paulhibbitts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdzylikecode%2FVSCodeExt-docsify-Preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdzylikecode%2FVSCodeExt-docsify-Preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdzylikecode%2FVSCodeExt-docsify-Preview/lists"}