{"id":18029866,"url":"https://github.com/zeioth/vim-jsdoc","last_synced_at":"2026-02-15T09:06:35.068Z","repository":{"id":159856483,"uuid":"631730427","full_name":"Zeioth/vim-jsdoc","owner":"Zeioth","description":"JsDoc integration for vim ","archived":false,"fork":false,"pushed_at":"2023-08-01T19:06:10.000Z","size":47,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T13:47:16.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zeioth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"Zeioth","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-04-23T23:27:23.000Z","updated_at":"2023-04-24T00:40:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"685c05e4-33a9-427f-bcc0-adc603edf997","html_url":"https://github.com/Zeioth/vim-jsdoc","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/Zeioth%2Fvim-jsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fvim-jsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fvim-jsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeioth%2Fvim-jsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zeioth","download_url":"https://codeload.github.com/Zeioth/vim-jsdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249549,"owners_count":20908212,"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-10-30T09:11:47.968Z","updated_at":"2025-10-10T11:05:44.693Z","avatar_url":"https://github.com/Zeioth.png","language":"Vim Script","funding_links":["https://github.com/sponsors/Zeioth"],"categories":[],"sub_categories":[],"readme":"# vim-jsdoc\nOut of the box, this plugin automatically regenerates your jsdoc\ndocumentation. Currently, this plugin is in highly experimental state.\n\n## Dependencies\n```sh\n# For this to work, you must install typedoc like\nsudo npm -g jsdoc\n```\n\nYou also need to have a 'jsdoc.json' file like this in your project root\ndirectory.\n```json\n{\n\t\"source\": {\n\t\t\"include\": [\"./src\"],\n\t\t\"includePattern\": \".+\\\\.js(doc|x)?$\",\n\t\t\"exclude\": \"node_modules/|docs\"\n\t},\n\t\"plugins\": [],\n\t\"opts\": {\n\t\t\"destination\": \"docs/\"\n\t}\n}\n```\nTo see all possiple options, check the\n[JsDoc official documentation](https://jsdoc.app/about-configuring-jsdoc.html).\n\n## Documentation\nPlease use \u003c:h jsdoc\u003e on vim to read the [full documentation](https://github.com/Zeioth/vim-jsdoc/blob/main/doc/jsdoc.txt).\n\n## How to use\nCopy this in your vimconfig:\n\n```\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\" =\u003e vim jsdoc\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n\" Enable it for the next languages\nlet g:jsdoc_include_filetypes = ['javascript']\n\n\" Enable the keybindings for the languages in g:jsdoc_include_filetypes\naugroup jsdoc_mappings\n  for ft in g:jsdoc_include_filetypes\n    execute 'autocmd FileType ' . ft . ' nnoremap \u003cbuffer\u003e \u003cC-h\u003e :\u003cC-u\u003eJsdocOpen\u003cCR\u003e'\n    \"execute 'autocmd FileType ' . ft . ' nnoremap \u003cbuffer\u003e \u003cC-k\u003e :\u003cC-u\u003eJsdocRegen\u003cCR\u003e'\n  endfor\naugroup END\n```\n\n## Most frecuent options users customize\n\nEnable automated doc generation on save (optional)\n```\n\" Enabled by default for the languages defined in g:jsdoc_include_filetypes\nlet g:jsdoc_auto_regen = 1\n```\n\nChange the way the documentation is opened (optional)\n```\n\" jsdoc - Open on browser\nlet g:jsdoc_browser_cmd = get(g:, 'jsdoc_browser_cmd', 'xdg-open')\nlet g:jsdoc_browser_file = get(g:, 'jsdoc_browser_file', './docs/index.html')\n```\n\nCustom command to generate the jsdoc documentation (optional)\n\n```\nlet g:jsdoc_cmd = 'jsdoc'\n```\n\nChange the way the root of the project is detected (optional)\n\n```\n\" By default, we detect the root of the project where the first .git file is found\nlet g:jsdoc_project_root = ['.git', '.hg', '.svn', '.bzr', '_darcs', '_FOSSIL_', '.fslckout']\n```\n\n## Final notes\n\nPlease have in mind that you are responsable for adding your jsdoc directory to the .gitignore if you don't want it to be pushed by accident.\n\nIt is also possible to disable this plugin for a single project. For that, create .nojsdoc file in the project root directory.\n\n## Credits\nThis project started as a hack of [vim-doxygen](https://github.com/Zeioth/vim-doxygen), which started as a hack of [vim-guttentags](https://github.com/ludovicchabant/vim-gutentags). We use its boiler plate functions to manage directories in vimscript with good compatibility across operative systems. So please support its author too if you can!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeioth%2Fvim-jsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeioth%2Fvim-jsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeioth%2Fvim-jsdoc/lists"}