Skip to content
gh-docs

YAML output

YAML is the default index output. Use .yml or .yaml with --file, or select --format yaml.

Terminal window
gh docs index --owner mindovermachine-dev --file docs-repos.yml

The output is a sequence of repositories. Each entry contains name, description, and homepageUrl:

- name: remote-astro-theme
  description: A remote Astro theme for documentation sites
  homepageUrl: https://docs.example.org/remote-astro-theme/

An empty GitHub homepage URL is emitted as an empty string. The repository description and homepage URL reflect the metadata returned by gh repo list.

See JSON, HTML, and Starlight sidebar for other formats.