
Product
Introducing Socket Firewall Enterprise: Flexible, Configurable Protection for Modern Package Ecosystems
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
@5minds/processcube_docflow
Advanced tools
A command to generate a documentation website for BPMN diagrams.
The website is generated from a processes directory containing BPMN diagrams
and a README.md file in the root directory of your project.
processes directory.README.md file in the root directory of your project.npm i -g @5minds/processcube_docflow in the root directory of your project to install the package.docflow build to generate the documentation website.docflow serve to start the server.http://localhost:3000 in your browser.docker run -p 3000:3000 -t -i -v ./processes:/src/processes -v ./README.md:/src/README.md 5minds/processcube_docflow
http://localhost:3000 in your browser.Running docflow without any arguments will show the help message.
You can set environment variables during build or serve to configure the behavior of the command:
OUT_DIR: The output directory for the build. Default: .staticBASE_PATH: The base path for the app. Default: /. Used for Path-Based RoutingPROCESSES_DIR: Custom path for processesREADME_PATH: Custom path to a README.mdIf you want to run the app locally, you need Docker-Desktop and Node.js installed.
If you want to develop and test the package locally, you can do the following to start the apps:
docker compose up -d to start the ProcessCube®-Containersnpm i to install the dependencies.npm run dev to start the Development-Server of the DocFlow-Apphttp://localhost:3000 in your browser.If you want to automatically generate and deploy the documentation website in your CI workflow, you can use the following template:
name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- main
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: 'pages'
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Setup Pages
id: setup-pages
uses: actions/configure-pages@v5
- name: Install DocFlow
run: npm i -g @5minds/processcube_docflow@develop
- name: Build Documentation
run: docflow build
env:
BASE_PATH: ${{ steps.setup-pages.outputs.base_path }}
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./.static
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
FAQs
Create webpage to view process documentation
The npm package @5minds/processcube_docflow receives a total of 1,703 weekly downloads. As such, @5minds/processcube_docflow popularity was classified as popular.
We found that @5minds/processcube_docflow demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 21 open source maintainers collaborating on the project.
Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.

Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.

Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.