# docs.bpmn.io

**Repository Path**: mirrors_bpmn-io/docs.bpmn.io

## Basic Information

- **Project Name**: docs.bpmn.io
- **Description**: bpmn.io Toolkit Documentation
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> The website is not published yet. It is still in WIP stage.

# docs.bpmn.io :notebook:
Welcome to docs.bpmn.io. This repository contains documentation for:

 - diagram-js
 - bpmn-js
 - dmn-js

libraries.

## Running Locally
This repository is based on [Jekyll](https://jekyllrb.com/) and hosted via [GitHub Pages](https://bpmn-io.github.io/docs.bpmn.io/). To run locally:

Install bundler if not installed before:
```shell
gem install bundler jekyll
```

Run the website:
```shell
bundle exec jekyll serve --incremental
```
This should take couple of minutes until the page is built and served in http://localhost:4000/ Note that the incremental flag helps to build only the modified pages, which makes thing much faster in case we're modifying the content.

**Note about search**

Pages added & removed from the docs should automatically be handled, so no need to do extra steps in order to take care of search functionality.

## Playing With Colors :art:

These color variables may be modified to achieve custom themes inside [bpmn-io.scss](https://github.com/bpmn-io/docs.bpmn.io/blob/master/_sass/color_schemes/bpmn-io.scss):

```
    $body-background-color
    $sidebar-color
    $border-color

    $body-text-color
    $body-heading-color
    $nav-child-link-color
    $search-result-preview-color

    $link-color
    $btn-primary-color
    $base-button-color

    $code-background-color
    $search-background-color
    $table-background-color
    $feedback-color
```

## Tip About Plugging Back DMN Content In

In order to plug back the DMN related content in into the website, undo [this commit](https://github.com/bpmn-io/docs.bpmn.io/commit/df4c780fd1ced6a1e6ccf206c8df37d9a88ec197).