# Jmix  Documentation

**Repository Path**: jmix/jmix-docs

## Basic Information

- **Project Name**: Jmix  Documentation
- **Description**: Jmix Framework 文档源文件
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: release_2_4
- **Homepage**: https://doc.jmix.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-30
- **Last Updated**: 2025-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jmix Documentation

This is the main repository of [Jmix](https://jmix.io) documentation. Guides are located in the repositories of the respective sample projects.  

The documentation is published at https://docs.jmix.io.

## Development

* Install IntelliJ IDEA and AsciiDoc plugin.
* Clone the repository and open the root folder in IntelliJ IDEA.
* Import the Gradle project.
* Repositories of guides sample projects will be automatically cloned into the `external` folder.

Main documentation modules are located in the `content` folder. Guides are located in the `external/<sample>/doc` folders.

The AsciiDoc IntelliJ plugin correctly recognizes all modules by their `antora.yml` files and allows you to make cross-references.

### Contributing a Jmix Guide

To add a new guide to the Jmix documentation, follow the steps outlined in [CONTRIBUTING.md](CONTRIBUTING.md). The guide explains how to:

* Set up a new example project based on the Jmix template.
* Organize your documentation structure with Antora.
* Submit your guide for review and integration into the Jmix Docs.

## Building

* Install Node LTS release from https://nodejs.org

* Open terminal in `jmix-docs` root folder and run:
  ```
  npm i
  npx antora antora-playbook.yml
  ```

* Open `jmix-docs/build/site/index.html` in a web browser.

The `antora-playbook.yml` file allows you to build a single version from the branch checked out locally. To build the entire site from the current state of remote repositories use `antora-playbook.ci.yml` and `--fetch` option:

```
npx antora --fetch antora-playbook.ci.yml
```