-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8950bb4
Showing
7 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
_arc42/ | ||
build/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "arc42-template"] | ||
path = arc42-template | ||
url = git@github.com:arc42/arc42-template.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.PHONY: copy-arc42 clean | ||
SRC_DIR=./_arc42/ | ||
clean: | ||
rm -rf $(SRC_DIR) | ||
copy-arc42: | ||
mkdir -p $(SRC_DIR)modules/ROOT/pages/ | ||
cp -R arc42-template/EN/asciidoc/** $(SRC_DIR)modules/ROOT/pages/ | ||
cp _antora.yml $(SRC_DIR)antora.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
name: arc | ||
title: ARC42 AsciiDoc Template | ||
version: 0.9.0 | ||
start_page: ROOT:arc42-template.adoc |
Submodule arc42-template
added at
bdc719
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
site: | ||
title: Antora ARC42 Template | ||
# the 404 page and sitemap files only get generated when the url property is set | ||
url: https://anoff.io/antora-arc42 | ||
start_page: arc42::index.adoc | ||
content: | ||
sources: | ||
- url: . | ||
branches: HEAD, master | ||
start_path: _arc42 | ||
ui: | ||
bundle: | ||
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable | ||
snapshot: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
= Antora & ARC42 | ||
Andreas Offenhaeuser <https://blog.anoff.io> | ||
|
||
> Trying to get started with Antora by publishing the ARC42 template | ||
|
||
== Setup | ||
|
||
First get some prerequisites | ||
|
||
. Get the https://github.com/arc42/arc42-template[arc42 template] as a git submodule | ||
. https://docs.antora.org/antora/2.0/install/install-antora/[install Antora] | ||
|
||
== Notes on folder structure | ||
|
||
. Antora expects all documentation to come in a _module_ (there can be only one module in a build) | ||
. the playbook can define multiple content sources | ||
.. each content source needs to point to a root directory of a git repo (local or remote) | ||
.. you can use `start_path` in a https://docs.antora.org/antora/2.0/playbook/playbook-schema/#content-category[playfile source] to make the docs start relative to the git root | ||
.. the repo must have at least one commit | ||
. within this start path https://docs.antora.org/antora/2.0/modules/#module-overview[a module structure] is expected | ||
.. the https://docs.antora.org/antora/2.0/component-descriptor/#component-descriptor-requirements[antora.yml] file defines to position of a module | ||
.. there must be a `modules/ROOT` (uppercase) module present | ||
.. all `.adoc` files must reside in the `modules/XYZ/pages` directory |