foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-01-31 04:58:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revise notes for custom Asciidoctor extensions

Browse Source
This commit is contained in:
Gabriel Arazas 2023-03-12 10:07:38 +08:00
parent 915825bdf9
commit 728075a37d
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gems/lib/asciidoctor/github-raw-content-include-processor/README.adoc
View File

@ -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.

1
gems/lib/asciidoctor/swhid-include-processor/README.adoc
View File

@ -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