Erbsland Regular Expression Library Documentation
=================================================

Welcome to the **Erbsland Regular Expression Library**. A *modern* and *secure* regular expression library built for C++20 and beyond. This implementation is designed to be secure, minimal in dependencies, and easy to integrate into your existing projects.

All you need is a C++20-compliant compiler and the standard library. That's it—no external dependencies, no hassle.

..
    .. button-ref:: get-started/index
        :ref-type: doc
        :color: success
        :align: center
        :expand:
        :class: sd-fs-2 sd-font-weight-bold sd-p-3

        Get Started with the Tutorial →

Topics
------

.. grid:: 3
    :margin: 4 4 0 0
    :gutter: 1

    .. grid-item-card:: :fas:`user;sd-text-success` How to Use the Library
        :link: usage/index
        :link-type: doc

        Learn how to integrate the library into your application, compile it, and run its unit tests with ease.

    .. grid-item-card:: :fas:`user-graduate;sd-text-success` Step-by-Step Tutorial
        :link: get-started/index
        :link-type: doc

        Follow a hands-on guide to build a small application using the regular expression library.

    .. grid-item-card:: :fas:`book-open;sd-text-success` Pattern Syntax
        :link: syntax/overview
        :link-type: doc

        Understand the supported syntax of this regular expression library.

    .. grid-item-card:: :fas:`code;sd-text-success` API Reference
        :link: reference/api/index
        :link-type: doc

        Access detailed reference material on all classes and methods.

    .. grid-item-card:: :fas:`layer-group;sd-text-success` Requirements
        :link: requirements
        :link-type: doc

        Review the technical requirements and environment setup needed to get started with the parser.

    .. grid-item-card:: :fas:`landmark;sd-text-success` License
        :link: license
        :link-type: doc

        Familiarize yourself with the terms of use under the Apache 2.0 license.


Contents at a Glance
---------------------

.. toctree::
    :maxdepth: 3

    usage/index
    get-started/index
    syntax/index
    reference/api/index
    reference/assembler/index
    contribute/index
    requirements
    goals
    license

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`