From 48ed3ea57b333ac1c54f4fb9335cddb72448260a Mon Sep 17 00:00:00 2001 From: DanRoscigno Date: Thu, 18 Apr 2024 15:43:03 -0400 Subject: [PATCH] readme Signed-off-by: DanRoscigno --- README.adoc | 10 ++++++++++ README.md | 14 -------------- 2 files changed, 10 insertions(+), 14 deletions(-) delete mode 100644 README.md diff --git a/README.adoc b/README.adoc index a61327e..e0b4bac 100644 --- a/README.adoc +++ b/README.adoc @@ -25,6 +25,16 @@ image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}] This fork of the Antora Default UI is being used by me to learn about Antora by documenting {url-writing-samples}[some of my work]. +The GitHub workflow is from Antora docs (I added the `npx gulp bundle`, which seems to be needed) + +Locally I use `make` to manage Docker when I want to preview the content. The Docker files, compose files, and the Makefile in this repo are from https://blog.swwomm.com/2020/10/antora-quick-start-tutorial.html + +``` +npx gulp bundle +make antora.build +make antora.run +``` + == Antora Code of Conduct The Antora project and its project spaces are governed by our https://gitlab.com/antora/antora/-/blob/HEAD/CODE-OF-CONDUCT.adoc[Code of Conduct]. diff --git a/README.md b/README.md deleted file mode 100644 index be174a8..0000000 --- a/README.md +++ /dev/null @@ -1,14 +0,0 @@ -Docker container and Makefile are from https://blog.swwomm.com/2020/10/antora-quick-start-tutorial.html - -GitHub workflow is from Antora docs (I added the `npx gulp bundle`, which seems to be needed) - -``` -mkdir -p content/documentation/modules/ROOT/pages/ -vi content/documentation/modules/ROOT/pages/index.adoc -vi Makefile -vi antora-playbook.yml -vi content/documentation/antora.yml -npx gulp bundle -make antora.build -make antora.run -```