Manifest examples

Use the following complete manifest as a starting point. Update project names, source paths, site metadata, and output paths to match the repository.

Markdown with Delphi API reference

This manifest defines project and site metadata, a Delphi source, Markdown guide content, Delphi API content, a project asset set, and HTML and CHM output targets:

json
{
  "edition": "2026",
  "project": {
    "name": "my-library",
    "title": "My Library",
    "description": "Developer documentation for My Library.",
    "homepage": "https://docinsight.github.io",
    "repository": "https://github.com/docinsight/mylibrary",
    "copyright": "Copyright © DevJet Software. All Rights Reserved.",
    "license": "Apache-2.0"
  },
  "sources": {
    "main": {
      "type": "delphi",
      "files": ["Packages/MyLibrary.dproj"],
      "options": {
        "compiler": "delphi_13",
        "platform": "Win32"
      }
    }
  },
  "content": {
    "docs": {
      "title": "Guide",
      "type": "markdown",
      "root": "docs",
      "mount": "/"
    },
    "api": {
      "title": "API Reference",
      "type": "delphi",
      "source": "main"
    }
  },
  "assets": {
    "images": {
      "root": "assets/images",
      "files": ["**/*.png", "**/*.svg"]
    }
  },
  "site": {
    "title": "My Library Documentation",
    "title_suffix": " | My Library Docs",
    "description": "Guides and reference for My Library.",
    "origin": "https://docinsight.github.io",
    "base_path": "/my-library/",
    "footer": {
      "notice": "{{project.copyright}}\nBuilt with {{sys.docinsight}}."
    }
  },
  "output": {
    "default_targets": ["site"],
    "targets": {
      "site": {
        "type": "html",
        "path": "dist/docs/site",
        "content": ["docs", "api"],
        "assets": ["images"]
      },
      "chm": {
        "type": "chm",
        "path": "dist/docs/chm/mylibrary.chm",
        "content": ["docs", "api"],
        "assets": ["images"]
      }
    }
  }
}

Both targets publish the guide at the output root, the API reference under api/, and the selected image files under images/. The site target remains the default; select chm explicitly when you need the help file.