Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: "Generate site using Antora site action"
uses: kameshsampath/antora-site-action@v0.2.0
uses: kameshsampath/antora-site-action@v0.2.4
with:
antora_playbook: antora-playbook.yml
- name: Deploy to GitHub Pages
Expand Down
16 changes: 16 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,20 @@ To build the site install Antora and run:

antora antora-playbook.yml

WARNING: Due to a https://gitlab.com/antora/antora/-/issues/745[bug] this will _not_ currently work in Node 16. I recommend using the latest LTS release (14) until the issue is resolved.

== Development

During development, it can be helpful to change the playbook so that the source does point at the local directory instead of the remote git repository:

[source,yaml]
----
content:
sources:
- url: ./
branches: HEAD
----

NOTE: Antora does not recognize git submodules as git repositories

The design & layout comes from our https://github.com/stackabletech/documentation-ui[UI repository].
4 changes: 4 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ ui:
contents: |
static_files: [ .nojekyll ]
- path: .nojekyll

asciidoc:
attributes:
base-repo: https://github.com/stackabletech
10 changes: 0 additions & 10 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
= Stackable Documentation
:toc:
:toc-placement: preamble
:toclevels: 1
:showtitle:
:base-repo: https://github.com/stackabletech
:imagesdir: diagrams

// Need some preamble to get TOC:
{empty}


== Introduction

Expand Down