antora.yml

---
# Copyright (c) 2021 Red Hat, Inc.
# This program and the accompanying materials are made
# available under the terms of the Eclipse Public License 2.0
# which is available at https://www.eclipse.org/legal/epl-2.0/
# SPDX-License-Identifier: EPL-2.0
# Antora component version descriptor.
#
# See https://docs.antora.org/antora/latest/component-version-descriptor/
#
name: docs
title: Vale for writers at Red Hat
version: main # Define a Component Version with No Version
display_version: main
prerelease: false
start_page: user-guide:introduction.adoc
nav:
  - modules/user-guide/nav.adoc
  - modules/contributor-guide/nav.adoc
  - modules/reference-guide/nav.adoc
asciidoc:
  attributes:
    # for antora
    experimental: ""
    icons: font
    # for the project
    context: docs
    ibmsg: IBM Style Guide
    ibmsg-print: IBM Style Guide (print)
    ibmsg-url-print: https://www.pearson.com/us/higher-education/program/De-Respinis-IBM-Style-Guide-The-Conventions-for-Writers-and-Editors/PGM270594.html?tab=contents
    ibmsg-url: https://www.ibm.com/docs/en/ibm-style
    repository-name: vale-at-red-hat
    repository-url: https://github.com/redhat-documentation/vale-at-red-hat/
    repository-clone-url: git@github.com:redhat-documentation/vale-at-red-hat.git
    ssg: Red Hat supplementary style guide for product documentation
    ssg-url: https://redhat-documentation.github.io/supplementary-style-guide/
    valedict: Custom Vale open-source dictionary for American English.
    valedict-url: https://github.com/errata-ai/en_US-web
    page-pagination: true # display links to previous/next pages at the bottom of the page