foodogsquared/asciidoctor-foodogsquared-extensions
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions.git synced 2025-01-31 04:58:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
627ccd3f20
asciidoctor-foodogsquared-e.../lib/asciidoctor/github-raw-content-include-processor
History
Gabriel Arazas 1c1deb96eb Update custom extensions to use open-uri-cached
2023-05-03 14:02:33 +08:00
..
extension.rb Update custom extensions to use open-uri-cached 2023-05-03 14:02:33 +08:00
README.adoc Revise notes for custom Asciidoctor extensions 2023-03-12 10:07:38 +08:00

README.adoc

Table of Contents

This is a include processor for easily including files from GitHub. Take note this will only include files. For directories, submodules, or symlinks: they will not be processed and a warning will be issued.

The following is the basic form of using this include processor.

include::github:$OWNER/$REPO[]

Extra notes

The include processor will use GitHub API. It can create authorized requests by setting a token in GITHUB_API_BEARER_TOKEN environment variable. For instructions on how to get a token, you can refer to respective documentation.

Attributes

  • path for the path of the file to be included. This is practically required as the root entry of the repository is a directory.

  • rev is the name of the commit/tag/branch to be checked out.

Example usage

  • include::github:asciidoctor/asciidoctor[path=README.adoc, rev=v2.0.0] will include the Asciidoc file from the Asciidoctor GitHub repo from the point of v2.0.0.

  • include::github:NixOS/nixpkgs[path=shell.nix] will get the latest revision of shell.nix from nixpkgs repository.

  • include::github:foo-dogsquared/nixos-config[] should not be processed considering it points to the root directory of the repository.