{"id":16886116,"url":"https://github.com/vdustr/doc-tab","last_synced_at":"2025-07-17T23:31:36.519Z","repository":{"id":199441687,"uuid":"702824620","full_name":"VdustR/doc-tab","owner":"VdustR","description":"Edit the doc comments in a new tab.","archived":false,"fork":false,"pushed_at":"2023-10-10T08:46:56.000Z","size":129,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-14T16:38:07.176Z","etag":null,"topics":["comment","documentation","eslint","javascript","jsdoc","markdown","md","prettier","tsdoc","typescript","visual-studio-code","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=VdustR.doc-tab","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/VdustR.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}},"created_at":"2023-10-10T05:03:29.000Z","updated_at":"2023-11-18T21:32:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"69efce79-e93a-4c11-8cb3-2277718a31f6","html_url":"https://github.com/VdustR/doc-tab","commit_stats":null,"previous_names":["vdustr/doc-tab"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VdustR%2Fdoc-tab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VdustR%2Fdoc-tab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VdustR%2Fdoc-tab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VdustR%2Fdoc-tab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VdustR","download_url":"https://codeload.github.com/VdustR/doc-tab/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226309192,"owners_count":17604299,"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":["comment","documentation","eslint","javascript","jsdoc","markdown","md","prettier","tsdoc","typescript","visual-studio-code","vscode","vscode-extension"],"created_at":"2024-10-13T16:38:20.898Z","updated_at":"2024-11-25T10:25:00.772Z","avatar_url":"https://github.com/VdustR.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doc Tab\n\nEdit the doc comments in a new tab.\n\n\"Doc Tab\" is a Visual Studio Code extension that allows you to edit the doc comments in a new tab.\n\n## The Problem\n\nEditors like VSCode support markdown preview for JSDoc / TSDoc, but it's often challenging to edit, format, and indent it within the comment block. This extension is designed to assist in editing doc comments in a new tab, providing the benefits of specific language features such as Markdown's syntax highlighting, intelligence, linting, and formatting.\n\n## Usage\n\n1. Choose or position the cursor within the documentation comment block.\n2. Access the command palette:\n   - `Ctrl+Shift+P` on Windows/Linux\n   - `Cmd+Shift+P` on macOS\n3. Enter `Doc Tab: Edit Comment In New Tab` and hit `Enter`.\n4. Modify the documentation comment in the new tab.\n5. Close the tab without saving to discard any alterations.\n6. The changes will be applied to the documentation comment block. 🎉🎉\n\n## Recommended Workflow\n\n1. Format the code (using eslint, prettier, etc.).\n2. Edit the documentation comments in a new tab. It's advisable to [preview](https://code.visualstudio.com/docs/languages/markdown#_markdown-preview) while editing.\n3. Format the code in the new tab.\n4. Close the tab without saving.\n5. Format the code once again.\n6. Reformat the documentation comments (using [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)).\n\n[📽️ Youtube Demo](https://youtu.be/mC6cOQaAY-A)\n\n## Recommended Extensions for Combined Use\n\n- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n- [eslint-stylistic](https://github.com/eslint-stylistic/eslint-stylistic)\n- [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)\n\n## License\n\n[VdustR](https://github.com/VdustR) © [MIT](https://github.com/VdustR/doc-tab/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvdustr%2Fdoc-tab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvdustr%2Fdoc-tab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvdustr%2Fdoc-tab/lists"}