foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-01-31 13:58:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c08511a1ce
website/gems/lib/asciidoctor/gitlab-raw-content-include-processor
History
Gabriel Arazas a981747141
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 Update documentation for various Asciidoctor extensions 2023-04-16 11:08:11 +08:00

README.adoc

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 include the README content from the master branch of GitLab source code.

  • include::freedesktop-sdk/freedesktop-sdk[rev=bcb3e0de957519e87a4c7b8c0e40af9876e531e7, path=.gitlab-ci.yml] should transclude the GitLab CI configuration from Freedesktop SDK.

  • include::World/warp[domain=gitlab.gnome.org, rev=v0.5.2, path=meson_options.txt] includes meson_options.txt from Warp source code at v0.5.2.