Skip to content

Commit 09d1498

Browse files
authored
Merge pull request #483 from butler54/readme-fixes
fix: Make it clear you need ascii doctor
2 parents b16081d + 77c340f commit 09d1498

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22

33
This project contains the new proof-of-concept documentation site for [validatedpatterns.io](validatedpatterns.io).
44

5-
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).
5+
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.
66

7-
Alternatively, you can build this site using [Hugo](https://gohugo.io/).
7+
Alternatively, you can build this site using [Hugo](https://gohugo.io/) and [Asciidoctor](https://asciidoctor.org).
88

99
## Install Hugo
1010

1111
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/).
1212

13-
## Run Hugo as a local server
13+
## Install Asciidoctor
14+
15+
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).
16+
17+
18+
## Deploy the website locally using Hugo
1419

1520
You can run Hugo as a local server to test out the site.
1621

0 commit comments

Comments
 (0)