Skip to content

fix: Make it clear you need ascii doctor #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2024
Merged

fix: Make it clear you need ascii doctor #483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down