{"id":21480325,"url":"https://github.com/dlang/ddox","last_synced_at":"2026-01-27T06:01:11.258Z","repository":{"id":4940610,"uuid":"6097562","full_name":"dlang/ddox","owner":"dlang","description":"Advanced D documentation engine","archived":false,"fork":false,"pushed_at":"2025-10-28T07:25:22.000Z","size":2154,"stargazers_count":69,"open_issues_count":71,"forks_count":20,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-10-28T08:12:56.799Z","etag":null,"topics":["dlang","documentation-generator","vibe-d"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"benvanstaveren/Mojolicious-Plugin-Database","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dlang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"dlang","open_collective":"dlang","custom":"https://dlang.org/foundation/donate.html"}},"created_at":"2012-10-05T22:21:14.000Z","updated_at":"2025-10-28T06:09:08.000Z","dependencies_parsed_at":"2025-10-15T21:03:55.464Z","dependency_job_id":"3028ba1f-40b2-473c-88ba-4692f52a67d3","html_url":"https://github.com/dlang/ddox","commit_stats":null,"previous_names":["dlang/ddox","rejectedsoftware/ddox"],"tags_count":104,"template":false,"template_full_name":null,"purl":"pkg:github/dlang/ddox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fddox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fddox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fddox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fddox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dlang","download_url":"https://codeload.github.com/dlang/ddox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fddox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28805319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T05:43:52.625Z","status":"ssl_error","status_checked_at":"2026-01-27T05:43:48.957Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["dlang","documentation-generator","vibe-d"],"created_at":"2024-11-23T12:14:33.992Z","updated_at":"2026-01-27T06:01:11.242Z","avatar_url":"https://github.com/dlang.png","language":"HTML","funding_links":["https://github.com/sponsors/dlang","https://opencollective.com/dlang","https://dlang.org/foundation/donate.html"],"categories":[],"sub_categories":[],"readme":"DDOX documentation engine\n==========================\n\nThis is an alternative documentation generator for programs written in the D programming language. It aims to be fully compatible with Ddoc (the documentation generator built into the D compiler). Additional features include:\n\n - Advanced page-per-symbol layout based on Diet templates\n - Full automatic cross-referencing\n - Automatically generated index, search database and site map\n - Filtering of symbols and modules based on their name and protection level\n - Integrated web server for fast local documentation serving\n - Directly embeddable into vibe.d applications\n\nFor real world examples see the [vibe.d API documentation](http://vibed.org/api/) and the [D standard library documentation](http://dlang.org/library/index.html).\n\n[![Build Status](https://github.com/rejectedsoftware/ddox/actions/workflows/ci.yml/badge.svg)](https://github.com/rejectedsoftware/ddox/actions/workflows/ci.yml)\n\n\nFirst steps\n-----------\n\n1. Install [dub](https://github.com/dlang/dub/)\n2. Generate JSON for your project by adding the command line switches `-D -X -Xfdocs.json` to your DMD command line (Note that you may need to clean up all the generated .html files afterwards)\n3. Check out ddox and run `dub build` from its root folder\n\nNote that DDOX uses [vibe.d](https://github.com/rejectedsoftware/vibe.d/), which currently by default uses libevent as its core. Please follow its installation instructions, too, if necessary.\n\nFiltering docs\n--------------\n\nYou can filter the JSON file using `ddox filter \u003cpath_to_json\u003e`.\n\nThe following command will filter out all modules starting with \"core.sync.\", except those starting with \"core.sync.mutex\" or \"core.sync.condition\". `--in` always takes precedence over `--ex` here. Additionally, all members with a protection lower than public will be filtered out.\n\n\t./ddox filter path/to/docs.json --ex core.sync. --in core.sync.mutex --in core.sync.condition --min-protection Public\n\n\nServing the docs on localhost\n-----------------------------\n\nEnsure your current working directory contains ddox's directory \"public\", or a modified version of it (otherwise the CSS stylings and JavaScript extras won't work).\n\n\tcd path/to/ddox\n\nThen, simply run the following command and go to \u003chttp://127.0.0.1:8080/\u003e\n\n\t./ddox serve-html path/to/docs.json\n\nGenerating offline documentation\n--------------------------------\n\nThe following commands will generate HTML docs (along with the default CSS stylings and JavaScript extras) in the folder \"destination/path/public\":\n\n\tcp -r path/to/ddox/public destination/path\n\t./ddox generate-html path/to/docs.json destination/path/public\n\n\nBuilt-in support in DUB\n-----------------------\n\nDocumentation for DUB projects can be built as simple as by running the following command within the project's directory:\n\n\tdub build -b ddox\n\nThe `\"-ddoxFilterArgs\"` field in `dub.json` (resp. `x:ddoxFilterArgs` in `dub.sdl`) can be used to customize the included contents.\n\nQuickly serving the documentation on a local HTTP server, which is usually faster than writing out all HTML files to disk, is also possible:\n\n\tdub run -b ddox\n\n\nDDOX specific Ddoc macros\n-------------------------\n\nApart from the standard set of predefined macros, DDOX defines a macro `DDOX_ROOT_DIR`, which contains the relative path to the root of the documentation hierarchy (ending with a slash). It can be used to link to resources that reside in a fixed location within the same directory tree.\n\n\nKnown issues\n------------\n\nThere are a number of issues due to limitations of the JSON output that DMD generates:\n\n- User defined attributes don't show up in the documentation (issue #6)\n- Declarations within `static if` are not shown (issues #19 and #86)\n- Modules without a documented module declaration are omitted (issues #164 and #10)\n- Some declarations with complex types may fail to parse and will be missing proper cross linking\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang%2Fddox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdlang%2Fddox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang%2Fddox/lists"}