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

Update documentation for various Asciidoctor extensions

Browse Source
This commit is contained in:
Gabriel Arazas 2023-04-16 11:06:10 +08:00
parent 7e329e0d16
commit e8ed4017e0
3 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/asciidoctor/chat-block-processor/README.adoc
View File

@ -102,4 +102,14 @@ Hello there!
.... ....
- The following block should contain El Pablo's melodramatic dialog state. - The following block should contain El Pablo's melodramatic dialog state.
Take note Take note of the resulting path for the image which is in kebab-case.
+
....
[chat, El Pablo, state=melodramatic]
====
What tragedy is happening here!
I couldn't take it.
__Please__.
====
....

1
lib/asciidoctor/git-blob-include-processor/README.adoc
View File

@ -47,6 +47,7 @@ The extension is composed of two parts: an include processor and a preprocessor.
The preprocessor add a document attribute, `doccontentref`, which it gives the Git reference for that content. The preprocessor add a document attribute, `doccontentref`, which it gives the Git reference for that content.
`doccontentref` is the difference between the process working directory (`Dir.pwd`) and the base directory of the content to be converted. `doccontentref` is the difference between the process working directory (`Dir.pwd`) and the base directory of the content to be converted.
In case the process working directory is not entirely consistent for several reasons, you could give the attribute `rootdir` as the basis for the comparison. In case the process working directory is not entirely consistent for several reasons, you could give the attribute `rootdir` as the basis for the comparison.
As another option, you could also manually set `doccontentref` in case it isn't applicable (i.e., for multilingual sites in Hugo projects).
The include processor also accepts an empty target with the prefix (i.e., `include::git:[]`) as a shorthand for `include::git:{doccontentref}`. The include processor also accepts an empty target with the prefix (i.e., `include::git:[]`) as a shorthand for `include::git:{doccontentref}`.

6
lib/asciidoctor/gitlab-raw-content-include-processor/README.adoc
View File

@ -37,4 +37,8 @@ By default, it uses version `v4`.
== Example usage == Example usage
- `include::gitlab:gitlab-org/gitlab[rev=master, path=README.md]` should - `include::gitlab:gitlab-org/gitlab[rev=master, path=README.md]` should include the README content from the master branch of link:https://gitlab.com/gitlab-org/gitlab/[GitLab source code].
- `include::freedesktop-sdk/freedesktop-sdk[rev=bcb3e0de957519e87a4c7b8c0e40af9876e531e7, path=.gitlab-ci.yml]` should transclude the GitLab CI configuration from link:https://gitlab.com/freedesktop-sdk/freedesktop-sdk[Freedesktop SDK].
- `include::World/warp[domain=gitlab.gnome.org, rev=v0.5.2, path=meson_options.txt]` includes `meson_options.txt` from link:https://gitlab.gnome.org/World/warp/[Warp source code] at v0.5.2.