https://github.com/vshn/antora-bootstrap

This project provides a Cookiecutter template to generate full Antora websites including e-book generation, GitLab CI/CD integration, content examples and Docker + Kubernetes configuration files.
https://github.com/vshn/antora-bootstrap

antora asciidoc documentation

Last synced: 2 months ago
JSON representation

This project provides a Cookiecutter template to generate full Antora websites including e-book generation, GitLab CI/CD integration, content examples and Docker + Kubernetes configuration files.

• Host: GitHub
• URL: https://github.com/vshn/antora-bootstrap
• Owner: vshn
• Created: 2021-01-14T14:22:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-18T08:19:45.000Z (about 3 years ago)
• Last Synced: 2025-01-29T01:47:14.865Z (4 months ago)
• Topics: antora, asciidoc, documentation
• Language: Dockerfile
• Homepage:
• Size: 706 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.adoc

Awesome Lists containing this project

README

        
= Cookiecutter Template for Antora Documentation Sites

This project provides a https://cookiecutter.readthedocs.io/[Cookiecutter] template for creating https://antora.org/[Antora] documentation websites.

== Usage

. `cookiecutter https://github.com/vshn/antora-bootstrap.git`

. Follow the prompts asking for information

. `cd` into the newly created folder

. `make html` to create the Antora website in the `_public` subfolder

. `make pdf epub manpage kindle` to create the corresponding e-books

== Requirements

The requirements for this project are:

* Python 3.x

* https://cookiecutter.readthedocs.io/[Cookiecutter] 1.7 or higher.