From 77c340f476b996c7bd1b7a533557ec713dc1e42d Mon Sep 17 00:00:00 2001 From: Chris Butler Date: Sat, 5 Oct 2024 12:34:55 +1000 Subject: [PATCH] fix: Make it clear you need ascii doctor Signed-off-by: Chris Butler --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8847febd6..a96caef6c 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,20 @@ This project contains the new proof-of-concept documentation site for [validatedpatterns.io](validatedpatterns.io). -Use a container image to build the Validated Patterns documentation, locally. See [Preview the documentation using a container image](https://validatedpatterns.io/contribute/contribute-to-docs/#_preview_the_documentation_using_a_container_image). +Use a container image to build the Validated Patterns documentation, locally. See [Preview the documentation using a container image](https://validatedpatterns.io/contribute/contribute-to-docs/#_preview_the_documentation_using_a_container_image). This is recommended to ensure the local preview is the same as what is rendered in deployment pipelines. -Alternatively, you can build this site using [Hugo](https://gohugo.io/). +Alternatively, you can build this site using [Hugo](https://gohugo.io/) and [Asciidoctor](https://asciidoctor.org). ## Install Hugo You can install Hugo on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Hugo on your desired platform, see [Install Hugo](https://gohugo.io/getting-started/installing/). -## Run Hugo as a local server +## Install Asciidoctor + +You can install Asciidoctor on different platforms (Linux, Windows, macOS) using a number of methods. For more information on how to install Asciidoctor on your desired platform, see [Install Asciidoctor](https://asciidoctor.org/#installation). + + +## Deploy the website locally using Hugo You can run Hugo as a local server to test out the site.