{"id":31508141,"url":"https://github.com/hat0uma/doxygen-previewer.nvim","last_synced_at":"2025-10-02T21:07:12.607Z","repository":{"id":177059976,"uuid":"653201841","full_name":"hat0uma/doxygen-previewer.nvim","owner":"hat0uma","description":"A Neovim plugin for previewing doxygen documentation.","archived":false,"fork":false,"pushed_at":"2025-09-17T01:12:50.000Z","size":41,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-17T03:14:52.222Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","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/hat0uma.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-13T15:36:40.000Z","updated_at":"2025-09-17T01:12:54.000Z","dependencies_parsed_at":"2025-08-28T16:17:32.549Z","dependency_job_id":"67eb148e-c5bb-43b5-a51d-dd1704dd9967","html_url":"https://github.com/hat0uma/doxygen-previewer.nvim","commit_stats":null,"previous_names":["rikuma-t/doxygen-previewer.nvim","hat0uma/doxygen-previewer.nvim"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hat0uma/doxygen-previewer.nvim","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hat0uma%2Fdoxygen-previewer.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hat0uma%2Fdoxygen-previewer.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hat0uma%2Fdoxygen-previewer.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hat0uma%2Fdoxygen-previewer.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hat0uma","download_url":"https://codeload.github.com/hat0uma/doxygen-previewer.nvim/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hat0uma%2Fdoxygen-previewer.nvim/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278070995,"owners_count":25924867,"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","status":"online","status_checked_at":"2025-10-02T02:00:08.890Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-10-02T21:01:50.114Z","updated_at":"2025-10-02T21:07:12.601Z","avatar_url":"https://github.com/hat0uma.png","language":"Lua","readme":"# doxygen-previewer.nvim\n\nA Neovim plugin for previewing Doxygen documentation.\n\n![preview doxygen](https://github.com/hat0uma/doxygen-previewer.nvim/assets/55551571/d940e31b-eca4-42e7-a507-2b432f6e3533)\n\n## Features\n\n- Live preview of Doxygen-generated documentation in your browser.\n- Automated updates of the documentation preview when the source code is saved.\n- Finds the project's Doxyfile and use it for previewing. Generate without a Doxyfile is also possible.\n- Doxygen options for preview are configurable.\n\n## Requirements\n\n- Neovim v0.10.1 or later\n- Doxygen\n- [prelive.nvim](https://github.com/hat0uma/prelive.nvim) (for live preview)\n\n## Installation\n\nInstall the plugin using your favorite package manager.\n\nUsing [vim-plug](https://github.com/junegunn/vim-plug):\n\n```vim\nPlug 'hat0uma/prelive.nvim'\nPlug 'hat0uma/doxygen-previewer.nvim'\nlua require(\"doxygen-previewer\").setup()\n```\n\nUsing [lazy.nvim](https://github.com/folke/lazy.nvim):\n\n```lua\n{\n  \"hat0uma/doxygen-previewer.nvim\",\n  opts = {},\n  dependencies = { \"hat0uma/prelive.nvim\" },\n  cmd = {\n    \"DoxygenOpen\",\n    \"DoxygenUpdate\",\n    \"DoxygenStop\",\n    \"DoxygenLog\",\n    \"DoxygenTempDoxyfileOpen\"\n  },\n}\n\n```\n\n## Usage\n\nThe plugin provides the following commands:\n\n- `:DoxygenOpen` - Open Doxygen documentation preview. The preview is automatically updated when saving the buffer.\n- `:DoxygenUpdate` - Manually update the preview.\n- `:DoxygenStop` - Stop the Doxygen documentation preview.\n- `:DoxygenLog` - Open the Doxygen generation log.\n- `:DoxygenTempDoxyfileOpen` - Open the temporary Doxyfile used for preview.\n\n## Configuration\n\nThe plugin's behavior can be customized by providing a table to the `setup` function. Here are the defaults:\n\nFor live preview settings, see [prelive.nvim](https://github.com/hat0uma/prelive.nvim#Configuration).\n\n```lua\nrequire(\"doxygen-previewer\").setup({\n  --- Path to output doxygen results\n  tempdir = vim.fn.stdpath \"cache\",\n  --- If true, update automatically when saving.\n  update_on_save = true,\n  --- doxygen settings section\n  doxygen = {\n    --- doxygen executable\n    cmd = \"doxygen\",\n    --- doxyfile pattern.\n    --- Search upward from the parent directory of the file to be previewed and use the first match.\n    --- The directory matching the pattern is used as the cwd when doxygen is run.\n    --- If not matched, doxygen's default settings will be used. (see `doxygen -g -`)\n    doxyfile_patterns = {\n      \"Doxyfile\",\n      \"doc/Doxyfile\",\n    },\n    --- If the pattern in `doxyfile_patterns` setting is not found, use this parameter as cwd when running doxygen.\n    fallback_cwd = function()\n      return vim.fs.dirname(vim.api.nvim_buf_get_name(0))\n    end,\n    --- doxygen options to override.\n    --- For details, see [Doxygen configuration](https://www.doxygen.nl/manual/config.html).\n    --- Also, other options related to generation are overridden by default. see `Doxygen Options` section in README.md.\n    --- If a function is specified in the value, it will be evaluated at runtime.\n    --- For example:\n    --- override_options = {\n    ---   PROJECT_NAME = \"PreviewProject\",\n    ---   HTML_EXTRA_STYLESHEET = vim.fn.stdpath(\"config\") .. \"/stylesheet.css\"\n    --- }\n    --- @type table\u003cstring, string|fun():string\u003e\n    override_options = {},\n  },\n})\n```\n\n## Doxygen Options\n\nBy default the following settings are overridden for preview. If you want to set other options, you can change them with `doxygen.override_options`.\n\n| KEY              | VALUE                                    |\n| ---------------- | ---------------------------------------- |\n| INPUT            | .                                        |\n| FILE_PATTERNS    | \u003c\u003cpreview_file_name\u003e\u003e.\\*                 |\n| EXCLUDE_PATTERNS | \\*/.git/\\* \\*/.svn/\\* \\*/node_modules/\\* |\n| RECURSIVE        | YES                                      |\n| SEARCH_INCLUDES  | NO                                       |\n| EXTRACT_ALL      | YES                                      |\n\nIn addition, the following options are set inside the plugin. It is recommended not to change it because it is related to the generation destination.\n\n| KEY              | VALUE           |\n| ---------------- | --------------- |\n| OUTPUT_DIRECTORY | \\\u003c\\\u003ctempdir\\\u003e\\\u003e |\n| SHORT_NAMES      | NO              |\n| CASE_SENSE_NAMES | NO              |\n| CREATE_SUBDIRS   | NO              |\n| GENERATE_HTML    | YES             |\n| GENERATE_LATEX   | NO              |\n| GENERATE_MAN     | NO              |\n| GENERATE_RTF     | NO              |\n| GENERATE_XML     | NO              |\n\n## License\n\nMIT\n","funding_links":[],"categories":["Utility","Live Preview"],"sub_categories":["Indent"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhat0uma%2Fdoxygen-previewer.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhat0uma%2Fdoxygen-previewer.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhat0uma%2Fdoxygen-previewer.nvim/lists"}