# docsify-bpmnio

> This is a docsify plugin that can convert BPMN xml data to a picture in your docs.

Latest version **2.1.1** (published 2022-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify-bpmnio
pnpm add docsify-bpmnio
yarn add docsify-bpmnio
bun add docsify-bpmnio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2022-05-04 |
| First published | 2021-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 175.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | gsdenys |
| Maintainers | gsdenys |
| Keywords | docsify, bpmn, bpmn.io, bpm, process, documentation |

## Links

- npm: https://www.npmjs.com/package/docsify-bpmnio
- Repository: https://github.com/gsdenys/docsify-bpmnio
- Homepage: https://github.com/gsdenys/docsify-bpmnio#readme
- Issues: https://github.com/gsdenys/docsify-bpmnio/issues
- npm.io page: https://npm.io/package/docsify-bpmnio

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 2.1.1 (latest) — 2022-05-04
- 2.1.0 — 2022-05-03
- 2.0.0 — 2022-05-03
- 1.0.2 — 2021-09-30
- 1.0.1 — 2021-09-30
- 1.0.0 — 2021-09-29

## README

# docsify-bpmnio

This is a docsify plugin that can convert BPMN xml data to a picture in your docs.

## First - write your drawio File Path in Your Markdown File

```md
[filename](https://cdn.jsdelivr.net/npm/docsify-drawio/test.bpmn ':include :type=bpmn')
```

## Second - Add these lines in your docsify html File.

!! It must put in the header section 

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-bpmnio/style.css" />
<script src="https://cdn.jsdelivr.net/npm/docsify-bpmnio/viewer.min.js"></script>
<script src='https://cdn.jsdelivr.net/npm/docsify-bpmnio/bpmnio.js'></script>
```

## Third - Add A Markdown render function in your $docsify.

```js
window.$docsify = {
    // You just have to copy it to Your own html File
    markdown: {
      renderer: {

        code: function (bpmn, lang) {
          if (lang === 'bpmn') {
            if (window.bpmnioConverter) {
              return window.bpmnioConverter(bpmn)
            } else {
              return `<div class='bpmnio-code'>No bpmn.io converter</div>`
            }
          } else {
            return this.origin.code.apply(this, arguments);
          }
        }
      }
    },
  };
```

---
_Source: https://npm.io/package/docsify-bpmnio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._