{"id":35803413,"url":"https://github.com/dlang-community/harbored-mod","last_synced_at":"2026-01-07T12:01:15.325Z","repository":{"id":25207405,"uuid":"28631336","full_name":"dlang-community/harbored-mod","owner":"dlang-community","description":"A documentation generator for D with support for both DDoc and Markdown.","archived":false,"fork":false,"pushed_at":"2019-02-10T16:27:56.000Z","size":322,"stargazers_count":18,"open_issues_count":39,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-03-26T01:09:24.895Z","etag":null,"topics":["code-documentation","d","ddoc","dlang","documentation-generator","documentation-tool","markdown-doc"],"latest_commit_sha":null,"homepage":"","language":"D","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dlang-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE_1_0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-30T13:12:54.000Z","updated_at":"2024-03-26T01:09:24.896Z","dependencies_parsed_at":"2022-08-23T21:10:56.943Z","dependency_job_id":null,"html_url":"https://github.com/dlang-community/harbored-mod","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/dlang-community/harbored-mod","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang-community%2Fharbored-mod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang-community%2Fharbored-mod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang-community%2Fharbored-mod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang-community%2Fharbored-mod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dlang-community","download_url":"https://codeload.github.com/dlang-community/harbored-mod/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang-community%2Fharbored-mod/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28235224,"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":"2026-01-07T02:00:05.975Z","response_time":58,"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":["code-documentation","d","ddoc","dlang","documentation-generator","documentation-tool","markdown-doc"],"created_at":"2026-01-07T12:00:31.559Z","updated_at":"2026-01-07T12:01:15.320Z","avatar_url":"https://github.com/dlang-community.png","language":"D","funding_links":[],"categories":[],"sub_categories":[],"readme":"# harbored-mod [![CI status](https://travis-ci.org/dlang-community/harbored-mod.svg?branch=master)](https://travis-ci.org/dlang-community/harbored-mod/)\n\n## Introduction\n\nDocumentation generator for [D](https://www.dlang.org) with Markdown support, based on [harbored](https://github.com/economicmodeling/harbored).\n\nHarbored-mod supports both [DDoc](https://dlang.org/spec/ddoc.html) and [Markdown](https://daringfireball.net/projects/markdown/) in documentation comments, but DDoc takes precedence. \nThis means that there are slight differences from standard Markdown.\n\n## Getting started\n\n### Building\n\n- using git\n\n    - `git clone https://github.com/dlang-community/harbored-mod.git`\n    - `cd harbored-mod`\n    - `dub build`\n    \n- using DUB only\n\n    - `dub fetch harbored-mod`\n    - `dub build harbored-mod`\n\n### Setting up\n\nAt this point you should have a binary called `hmod` in the `bin`\ndirectory.\n\n-   Modify your `PATH` to point to the `bin` directory or copy the\n    binary into your project.\n-   From your project's directory, run `hmod`. This assumes your source\n    code is in the `./source` subdirectory (as is often the case with\n    `dub` projects) and that the `hmod` binary is in `PATH`, prepend\n    with `./` if it's in the project directory).:\n\n        hmod source\n\n    This will write generate documentation to the `./doc` subdirectory.\n    See `./doc/index.html`. Note that the main page will be blank,\n    although you should see a list of all modules on the left.\n\n    To further tweak the documentation, generate the default\n    configuration file:\n\n## Features\n\n- Supports DDoc **and** (most, see differences) Markdown syntax\n- Sensible defaults (get decent documentation without tweaking any settings)\n- Automatic cross-referencing in code blocks and `inline code`\n- Very fast\n- All command-line options can be set in a config file (`hmod.cfg`) so just `hmod` is enough to generate documentation\n- Generates one file per module/`class`/`struct`/`enum`/etc. by default, as opposed to one file per module (old Phobos documentation) or one file per symbol (`ddox`).\n- File paths can be made compatible with ddox using the non-default `--format=html-simple` option\n- Generated HTML enriched by classes to be more tweakable with CSS\n- Customizable main page, table of contents and style (CSS)\n- Can exclude modules/packages from documentation by their name (not file name)\n- Generated docs are usable without JavaScript (e.g. NoScript), JS may used for optional functionality\n- **Only** generates HTML, and is unlikely to support any other formats\n\n## Differences from vanilla Markdown\n\n- `---` will not generate a horizontal line, as it is used for DDoc blocks. Use `- - -` instead. This is still standard Markdown.\n- *emphasis* can be denoted by `*`, but not by `_` (this would break snake\\_case names).\n- This does not work (again because DDoc uses `---` to mark code blocks):\n\n    Subheading\n    ----------\n\nInstead, use either (standard Markdown):\n\n    ## Subheading\n\nOr (non-standard):\n\n    Subheading\n    **********\n    \n## Directory structure\n\n| Directory     | Contents                                                                                             |\n|---------------|------------------------------------------------------------------------------------------------------|\n| `./`          | This README, Makefile, license.                                                                      |\n| `./bin`       | Harbored-mod binaries when compiled.                                                                 |\n| `./src`       | Source code.                                                                                         |\n| `./strings`   | Files compiled into Harbored-mod to be used in generated documentation (e.g. the default CSS style). |\n\n## Credits\n\nHarbored-mod is based on [harbored](https://github.com/economicmodeling/harbored) by Brian Schott, \nwith modifications by Ferdinand Majerech aka Kiith-Sa,\nmaintained by the dlang-community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang-community%2Fharbored-mod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdlang-community%2Fharbored-mod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang-community%2Fharbored-mod/lists"}