Skip to content

Commit

Permalink
🌟 feat: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
anoff committed Jan 28, 2019
0 parents commit 8950bb4
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_arc42/
build/
3 changes: 3 additions & 0 deletions .gitmodules
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
8 changes: 8 additions & 0 deletions Makefile
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
4 changes: 4 additions & 0 deletions _antora.yml
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
1 change: 1 addition & 0 deletions arc42-template
Submodule arc42-template added at bdc719
14 changes: 14 additions & 0 deletions playbook.yml
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
23 changes: 23 additions & 0 deletions readme.adoc
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

0 comments on commit 8950bb4

Please sign in to comment.