Skip to content
Snippets Groups Projects
Commit 6ee634a7 authored by Dan Allen's avatar Dan Allen
Browse files

add local Antora playbook for previewing the content as an HTML site offline

parent e7b8eed3
No related branches found
No related tags found
No related merge requests found
/.cache/
/public/
......@@ -9,8 +9,8 @@ This documentation has been submitted as the initial contribution for the {url-a
== Documentation Structure
This repository is a registered content source in the {url-org}/docs.asciidoctor.org/blob/main/antora-playbook.yml[playbook file for docs.asciidoctor.org].
The source files are organized into a documentation component as described by the _antora.yml_ file.
To learn how to build this documentation using the playbook and Antora, see the https://docs.antora.org/antora/2.3/install-and-run-quickstart/[Install and Run Antora Quickstart].
The source files are organized into a documentation component as described by the [.path]_antora.yml_ file.
To learn how to build this documentation using the playbook file [.path]_local-antora-playbook.yml_ with Antora, see the https://docs.antora.org/antora/2.3/install-and-run-quickstart/[Install and Run Antora Quickstart].
== Copyright and License
......
# This is a configuration file for Antora.
# You can pass it to Antora to build this content as an HTML site for previewing offline.
#
# $ antora --clean local-antora-playbook.yml
#
# A copy of this documentation is also available online at https://asciidoctor-docs.netlify.app/asciidoc/current/
runtime:
cache_dir: ./.cache/antora
site:
title: AsciiDoc
start_page: asciidoc::index.adoc
git:
ensure_git_suffix: false
content:
sources:
- url: .
branches: HEAD
# ...or use this content source instead to pull the content directly from the repository
#- url: https://github.com/asciidoctor/asciidoc-docs
# branches: main
asciidoc:
attributes:
page-pagination: ''
experimental: ''
idprefix: '@'
idseparator: '-@'
table-caption: false
example-caption: false
listing-caption: false
hide-uri-scheme: '@'
url-org: https://github.com/asciidoctor
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
output:
dir: ./public
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment