> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/server/clients-and-utilities/graphical-and-enhanced-clients/dbforge-documenter-for-mariadb-and-mysql.md).

# dbForge Documenter

dbForge Documenter automatically generates MariaDB database documentation in HTML, PDF, and Markdown, with a range of options for adjusting the output.

{% hint style="info" %}
dbForge Documenter is third-party software, not developed or maintained by MariaDB and not included with MariaDB Server. MariaDB doesn't test, validate, or support it. Refer to its own documentation and license terms.
{% endhint %}

[**dbForge Documenter**](https://www.devart.com/dbforge/mysql/documenter/) is a useful tool for the MariaDB database that allows for the automatic generation of database documentation in such formats as HTML, PDF, and Markdown. Users can adjust the created documentation with a great variety of options.

Features are described in the following.

## Searchable MariaDB & MySQL Documentation

Search as you type. View the highlighted matching text after entering the name of a required object in the search field.

![](https://2988006611-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSsmexDFPv2xG2OTyO5yV%2Fuploads%2Fgit-blob-ec69821752b35ff713fabced0653cc400bef8846%2Fdoc-search.png?alt=media)

## Compatibility Options

Various cloud services: Amazon RDS, Amazon Aurora, Google Cloud, Oracle MySQL Cloud, Alibaba Cloud,

Security connections: Secure Socket Layer (SSL), Secure Shell (SSH), HTTP Tunneling, PAM Percona.

![compatibility](https://2988006611-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSsmexDFPv2xG2OTyO5yV%2Fuploads%2Fgit-blob-e65339ad0ea3d82762eb934ea6631922781c414a%2Fcompatiblity.png?alt=media)

## Database Structure

Detailed MariaDB database information, such as types, details, and properties of the objects, inter-object dependencies, and DDL codes.

![database-structure](https://2988006611-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSsmexDFPv2xG2OTyO5yV%2Fuploads%2Fgit-blob-2b5dfb70518db31074bf9e4e821b89523d0e355d%2Fdatabase-structure.png?alt=media)

## Customization of Document Management

Various style templates allowing for alteration of documentation layout.

![custom-features](https://2988006611-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSsmexDFPv2xG2OTyO5yV%2Fuploads%2Fgit-blob-41707fd6f4794235302cf5f4831ecb8e4e92872e%2Fcustom-features.png?alt=media)

## Document Formats

* HTML and PDF (searchable formats).
* Markdown.

![formats](https://2988006611-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSsmexDFPv2xG2OTyO5yV%2Fuploads%2Fgit-blob-c3cc5421e64d8881517314bd1026a1b4967cfefe%2Fformats.png?alt=media)

## Extended Properties Support

Edit or add an object description.

Download a free 30-day trial of dbForge Documenter for MariaDB and MySQL [here](https://www.devart.com/dbforge/mysql/documenter/download.html).

[Documentation](https://docs.devart.com/documenter-for-mysql/) is available, too.

| Version                 | Introduced                                                                                                                                                             |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| dbForge Documenter 10.1 | Support for the rds-ca-rsa2048-g1 SSL/TLS certificate for connecting to MariaDB servers on AWS and enhanced cloud compatibility features, new automation capabilities. |
| dbForge Documenter 10.0 | Support for MariaDB 11.4. Added support for temporal tables in MariaDB.                                                                                                |
| dbForge Documenter 2.2  | Support for MariaDB 11.3.                                                                                                                                              |
| dbForge Documenter 2.1  | Support for MariaDB 10.9 and 10.10.                                                                                                                                    |
| dbForge Documenter 2.0  | Connectivity support for MariaDB 10.5.                                                                                                                                 |

<sub>*This page is licensed: CC BY-SA / Gnu FDL*</sub>

{% @marketo/form formId="4316" %}