website/gems/lib/asciidoctor/github-link-inline-macro/README.adoc

Table of Contents

• Synopsis
• Attributes
• Example usage

An inline macro that easily links repositories from GitHub.

Synopsis

github:$OWNER/$REPO[$CAPTION]

If caption is missing, the link text will be the namespace (i.e., $OWNER/$REPO) of the repo.

Attributes

There are optional attributes for this macro.

• rev is the commit/branch/tag of the repo to be linked.

• path is the filepath to be linked within the repo.

Example usage

• github:foo-dogsquared/website will link to my website repository.

• github:NixOS/nixpkgs[nixpkgs nixos-unstable branch, rev=nixos-unstable] should link to the NixOS unstable branch of nixpkgs with a custom link text.

• github:errata-ai/vale[Vale v2.3.0 README, path=README.md, rev=v2.3.0] should link to the README of Vale v2.3.0.