From b543c0e3d196ed2288027c732af041e77b0c5bb9 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Wed, 14 Aug 2024 15:01:55 +0200 Subject: [PATCH 1/2] docs: document how to use tab blocks --- modules/contributor/nav.adoc | 1 + .../pages/docs/using-tab-blocks.adoc | 27 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 modules/contributor/pages/docs/using-tab-blocks.adoc diff --git a/modules/contributor/nav.adoc b/modules/contributor/nav.adoc index 2f0135f6e..75ed3792f 100644 --- a/modules/contributor/nav.adoc +++ b/modules/contributor/nav.adoc @@ -11,6 +11,7 @@ ** xref:docs/contributing-documentation.adoc[] *** xref:docs/overview.adoc[] *** xref:docs/style-guide.adoc[] +*** xref:docs/using-tab-blocks.adoc[] *** xref:docs/backporting-changes.adoc[] *** xref:docs/releasing-a-new-version.adoc[] *** xref:docs/troubleshooting-antora.adoc[] diff --git a/modules/contributor/pages/docs/using-tab-blocks.adoc b/modules/contributor/pages/docs/using-tab-blocks.adoc new file mode 100644 index 000000000..f3a0da89d --- /dev/null +++ b/modules/contributor/pages/docs/using-tab-blocks.adoc @@ -0,0 +1,27 @@ += Using tab blocks +:asciidoctor-tabs-gh: https://github.com/asciidoctor/asciidoctor-tabs + +The {asciidoctor-tabs-gh}[`asciidoctor/tabs`] extension is installed, so you can use tab blocks. +An example can be found in the xref:management:stackablectl:installation.adoc[stackablectl installation instructions]. + +== Syntax example + +[,asciidoc] +---- +[tabs] +==== +Tab A:: Contents of Tab A. + +Tab B:: ++ +Contents of Tab B. + +Tab C:: ++ +-- +Contents of Tab C. + +Contains more than one block. +-- +==== +---- From 1abae3e4f8668d3e3687ca2bb2a40e61bba4a344 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Wed, 14 Aug 2024 15:31:15 +0200 Subject: [PATCH 2/2] Update modules/contributor/pages/docs/using-tab-blocks.adoc Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com> --- modules/contributor/pages/docs/using-tab-blocks.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/contributor/pages/docs/using-tab-blocks.adoc b/modules/contributor/pages/docs/using-tab-blocks.adoc index f3a0da89d..e8599042e 100644 --- a/modules/contributor/pages/docs/using-tab-blocks.adoc +++ b/modules/contributor/pages/docs/using-tab-blocks.adoc @@ -4,6 +4,8 @@ The {asciidoctor-tabs-gh}[`asciidoctor/tabs`] extension is installed, so you can use tab blocks. An example can be found in the xref:management:stackablectl:installation.adoc[stackablectl installation instructions]. +TIP: Be sure to use different block indicators nested admonition blocks so that they don't conflict with the tab blocks. + == Syntax example [,asciidoc]