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

= GitHub link inline macro
:toc:


An inline macro that easily links repositories from GitHub.


== Synopsis

[source, asciidoc]
----
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.

- `issue` accepts the issue number to be linked in the GitHub repo.
Take note `issue` is exclusive to other attributes and has more precedence.
For example, if `issue` and `rev` are both present, the link for issue will be the result.


== Example usage

- `github:foo-dogsquared/website` will link to link:https://github.com/foo-dogsquared/website[my website repository].

- `github:NixOS/nixpkgs[nixpkgs nixos-unstable branch, rev=nixos-unstable]` should link to the link:https://github.com/NixOS/nixpkgs/tree/nixos-unstable[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 link:https://github.com/errata-ai/vale/blob/v2.3.0/README.md[README of Vale v2.3.0].

- `github:neovim/neovim[Neovim cannot open large files properly, issue=614]` should link to https://github.com/neovim/neovim/issues/614[an issue of Neovim].

- `github:neovim/neovim[Neovim cannot open large files properly, issue=614, rev=master]` should still link to https://github.com/neovim/neovim/issues/614[an issue of Neovim] since `issue` has more precedence over `rev`.
Add GitHub link inline macro 2023-03-06 04:04:04 +00:00			`= GitHub link inline macro`
			`:toc:`


			`An inline macro that easily links repositories from GitHub.`


			`== Synopsis`

			`[source, asciidoc]`
			`----`
			`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.

Add GitHub inline macro with `issue` attribute 2023-03-11 08:42:24 +00:00			- `issue` accepts the issue number to be linked in the GitHub repo.
			Take note `issue` is exclusive to other attributes and has more precedence.
			For example, if `issue` and `rev` are both present, the link for issue will be the result.

Add GitHub link inline macro 2023-03-06 04:04:04 +00:00
			`== Example usage`

			- `github:foo-dogsquared/website` will link to link:https://github.com/foo-dogsquared/website[my website repository].

			- `github:NixOS/nixpkgs[nixpkgs nixos-unstable branch, rev=nixos-unstable]` should link to the link:https://github.com/NixOS/nixpkgs/tree/nixos-unstable[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 link:https://github.com/errata-ai/vale/blob/v2.3.0/README.md[README of Vale v2.3.0].
Add GitHub inline macro with `issue` attribute 2023-03-11 08:42:24 +00:00
			- `github:neovim/neovim[Neovim cannot open large files properly, issue=614]` should link to https://github.com/neovim/neovim/issues/614[an issue of Neovim].

			- `github:neovim/neovim[Neovim cannot open large files properly, issue=614, rev=master]` should still link to https://github.com/neovim/neovim/issues/614[an issue of Neovim] since `issue` has more precedence over `rev`.