# doc

**Repository Path**: mirrors_assertj/doc

## Basic Information

- **Project Name**: doc
- **Description**: AssertJ new website
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-15
- **Last Updated**: 2026-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AssertJ User Guide

[![Github CI status](https://github.com/assertj/doc/workflows/CI/badge.svg)](https://github.com/assertj/doc/actions?query=workflow%3ACI)

The AssertJ User Guide is available here: https://assertj.github.io/doc/

This project contains the AsciiDoc sources for the guide.

## Structure

- `src/docs/asciidoc`: AsciiDoc files
- `src/test/java`: Java test source code that can be included in the AsciiDoc files
- `src/test/resources`: Classpath resources that can be included in the AsciiDoc files or
  used in tests

## Usage

### Generate AsciiDoc

This following Gradle command generates the HTML version of the User Guide as
`build/docs/asciidoc/user-guide/index.html`.

```bash
gradlew asciidoctor
```