{"id":14985933,"url":"https://github.com/shiinasama/roxy","last_synced_at":"2026-02-06T01:34:55.026Z","repository":{"id":249827254,"uuid":"832661632","full_name":"SHIINASAMA/roxy","owner":"SHIINASAMA","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-17T07:23:07.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T22:12:07.589Z","etag":null,"topics":["action","doxygen","doxygen-awesome-css","package"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SHIINASAMA.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-23T13:21:22.000Z","updated_at":"2024-12-17T07:15:55.000Z","dependencies_parsed_at":"2024-07-23T16:09:13.799Z","dependency_job_id":"86647e54-137d-409a-9398-f91fe04984e4","html_url":"https://github.com/SHIINASAMA/roxy","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":0.07692307692307687,"last_synced_commit":"b96fbde32887431de1a18f49b348507138081b7f"},"previous_names":["shiinasama/roxy"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/SHIINASAMA/roxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHIINASAMA%2Froxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHIINASAMA%2Froxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHIINASAMA%2Froxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHIINASAMA%2Froxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SHIINASAMA","download_url":"https://codeload.github.com/SHIINASAMA/roxy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SHIINASAMA%2Froxy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264169164,"owners_count":23567263,"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":["action","doxygen","doxygen-awesome-css","package"],"created_at":"2024-09-24T14:11:58.342Z","updated_at":"2026-02-06T01:34:54.991Z","avatar_url":"https://github.com/SHIINASAMA.png","language":"Shell","readme":"# Roxy\n\nThis is a generic solution for `doxygen` + `doxygen-awesome-css`, as well as support for bundling static assets into doxygen output.\n\nSupport GitHub README/Pages, GitLab README/Pages.\n\n## Usage\n\n### GitHub Action\n\n[Source](https://github.com/libsese/sese)\n\n```yml\n- name: Build docs\n  uses: SHIINASAMA/roxy@1.1\n  with:\n    DOXYFILE: 'docs/Doxyfile'\n    RESOURCE_FOLDER: 'static'\n    OUTPUT_FOLDER: 'build/html'\n```\n\n### GitLab CI\n\n[Source](https://gitlab.mikumikumi.xyz/kaoru/roxy-example)\n\n```yml\nstages:\n  - deploy\n\npages:\n  stage: deploy\n  image: reg.mikumikumi.xyz/base/roxy\n  variables:\n    PROJECT_PATH: /builds/kaoru/roxy-example\n    DOXYFILE: docs/Doxyfile\n    RESOURCE_FOLDER: static\n    OUTPUT_FOLDER: build/docs\n  script:\n    - /usr/local/bin/entrypoint.sh\n    - mv build/docs public\n  artifacts:\n    paths:\n      - public\n  rules:\n    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH\n      when: always\n```\n\n### docker\n\n[Source](https://github.com/libsese/sese)\n\n```sh\ndocker build -t roxy .\ndocker run --rm -e DOXYFILE=docs/Doxyfile -e PROJECT_PATH=/project -e OUTPUT_FOLDER=build/html -e RESOURCE_FOLDER=static -v .:/project roxy\n```\n\n\u003e [!NOTE]\n\u003e The `OUTPUT_FOLDER` must be the same as the html output location in the `DOXYFILE` configuration file.\n\n## Arguments\n\n - `DOXYGEN_AWESOME_CSS_VERSION`:\n   version of doxygen-awesome-css, defalut to v2.3.3\n - `PROJECT_PATH`:\n   project path\n - `DOXYGEN_CONTEXT_FOLDER`:\n   Doxygen working dir in PROJECT_PATH\n - `DOXYFILE`:\n   doxyfile file in PROJECT_PATH\n - `RESOURCE_FOLDER`:\n   resource folder in PROJECT_PATH\n - `OUTPUT_FOLDER`:\n   doxygen folder in PROJECT_PATH\n\n## Apply doxygen-awesome-css\n\nDoxygen can not overwrite option via cli, You may set options by manually:\n\n```ini\nGENERATE_HTML=YES\nMARKDOWN_SUPPORT=YES\nGENERATE_TREEVIEW=YES\nDISABLE_INDEX=NO\nFULL_SIDEBAR=NO\nHTML_COLORSTYLE=LIGHT\nHTML_HEADER=/doxygen-awesome-css/doxygen-custom/header.html\nHTML_EXTRA_STYLESHEET=/doxygen-awesome-css/doxygen-awesome.css,/doxygen-awesome-css/doxygen-awesome-sidebar-only.css,/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css,/doxygen-awesome-css/doxygen-custom/custom.css,/doxygen-awesome-css/doxygen-custom/custom-alternative.css\nHTML_EXTRA_FILES=/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js,/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js,/doxygen-awesome-css/doxygen-awesome-interactive-toc.js,/doxygen-awesome-css/doxygen-awesome-paragraph-link.js,/doxygen-awesome-css/doxygen-awesome-tabs.js,/doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiinasama%2Froxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshiinasama%2Froxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiinasama%2Froxy/lists"}