<pre><code class="language-markdown">## Overview
If you're looking to dive into the world of documentation for Jenkins X, this collection of resources is a great starting point. The repository provides a comprehensive guide on how to build and manage your documentation for Jenkins X, whether you're working on it locally or using a containerized environment. With easy-to-follow instructions, both newcomers and experienced contributors can easily navigate the necessary processes involved in setting up and maintaining the docs.

This resource not only equips you with how to prepare your sources and run the Hugo site generator but also offers practical tools for common workflows, such as spell checking and link validation. It's designed for ease of use and to streamline the documentation process for everyone involved.

## Features
- **Easy Local Setup**: Clone the repository with git and navigate through the necessary Git submodules effortlessly to get started right away.

- **Hugo Integration**: Build the documentation site using Hugo, with flexibility to run it either locally on your machine or in a Docker container.

- **Spell Check Support**: Automatically run spell checks on markdown files using node-markdown-spellcheck, helping you maintain high-quality content free of typos.

- **Link Validation**: Utilize htmlproofer to check the validity of links and images within the documentation, ensuring a smooth user experience.

- **Environment Variable Management**: Set necessary environment variables like HUGO_GH_ACCESS_TOKEN simply, enabling seamless access to the Jenkins X repository.

- **Detailed Contribution Guidelines**: Comprehensive instructions for contributors on how to add enhancements, localization, and other valuable content to the documentation.

- **Containerized Development**: Easily spin up a Hugo server using Docker, providing a familiar environment without cumbersome installations directly on your machine.
</code></pre>


Jenkins X

Jx Docs