From 428723d04f6706cf955cd1fc0e6230f28f7c538f Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Sun, 12 Mar 2023 10:07:38 +0800 Subject: [PATCH] Revise notes for custom Asciidoctor extensions --- .../github-raw-content-include-processor/README.adoc | 9 ++++++++- lib/asciidoctor/swhid-include-processor/README.adoc | 1 + 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/asciidoctor/github-raw-content-include-processor/README.adoc b/lib/asciidoctor/github-raw-content-include-processor/README.adoc index 6b1dcbe..7c1f204 100644 --- a/lib/asciidoctor/github-raw-content-include-processor/README.adoc +++ b/lib/asciidoctor/github-raw-content-include-processor/README.adoc @@ -12,10 +12,17 @@ The following is the basic form of using this include processor. [source, asciidoc] ---- -include::github:$OWNER/$REPO[] +\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 link:https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api?apiVersion=2022-11-28#authenticating[respective documentation]. + + == Attributes - `path` for the path of the file to be included. diff --git a/lib/asciidoctor/swhid-include-processor/README.adoc b/lib/asciidoctor/swhid-include-processor/README.adoc index 6c8ed46..dbdc29d 100644 --- a/lib/asciidoctor/swhid-include-processor/README.adoc +++ b/lib/asciidoctor/swhid-include-processor/README.adoc @@ -34,6 +34,7 @@ This include processor also respects the safe mode setting. This means in order to permit including by SWHID, you have to permit link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-uri/[includes by URIs]. Lastly, this include processor uses the Software Heritage API which includes a limitation. +You could create authorized requests by setting `SWH_API_BEARER_TOKEN` environment variable with a token. == Example usage