downloadTemplate

Ralf D. Müller Johannes Thorn Pascal Euhus

2 minutes to read

About This Task

This task is primarily used to bootstrap a new project. You can choose to download an official template like arc42 or req42 (both available in multiple languages) or you can register and use your own custom template.

Setup and Configuration

You can choose to bootstrap your project as an Antora project or as a plain AsciiDoc project. The Antora integration is currently in beta. The Antora integration enables you to register the project seamlessly with an existing Antora playbook.

experimental Antora support

  • to test the Antora template

    • install antora: https://docs.antora.org/antora/latest/install/install-antora/

    • download the arc42 template as antora style ./dtcw downloadTemplate

    • create a playbook.yaml within the root of your project

    • make sure that your project is a valid git repository and contains at least one commit

    • execute antora playbook.yml

playbook.yml
site:
  title: Antora ARC42 Template
  start_page: arc42-template::index.adoc
content:
  sources:
  - url: ./
    start_path: src/docs/arc42
    branches: [HEAD]
ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true
asciidoc:
  attributes:
    sectanchors: true

output:
  dir: build/antora
Note
 To install antora, follow the instructions on https://docs.antora.org/antora/latest/install-and-run-quickstart/

Further Reading and Resources