foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-01-31 19:57:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ebe5160358
website/gems/lib/asciidoctor/gitlab-raw-content-include-processor/README.adoc

1.1 KiB
Raw Blame History

Table of Contents

It’s a include processor for easily including raw content from GitLab repositories.

Synopsis

Unresolved directive in <stdin> - include::gitlab/$OWNER/$REPO[rev=$COMMIT, path=$FILEPATH]

Extra notes

A personal access token is most likely required. Get one and place the value in an environment variable GITLAB_API_PERSONAL_ACCESS_TOKEN.

Attributes

There are some attributes required to be passed.

  • rev is the commit to be checked out.

  • path is the file path to be included.

Aside from the required attributes, there are optional attributes to configured further.

  • domain is the domain of the GitLab instance. By default, it points to the gitlab.com official instance.

  • version is the version string of the API to be used. By default, it uses version v4.

Example usage

  • include::gitlab:gitlab-org/gitlab[rev=master, path=README.md] should