Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
@5minds/processcube_docflow
Advanced tools
Create static webpage to view process documentation
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: .static
BASE_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 develop and test the package locally, you can do the following:
npm i
to install the dependencies.npm link
to link the package. docflow
should be available now.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 static webpage to view process documentation
The npm package @5minds/processcube_docflow receives a total of 2 weekly downloads. As such, @5minds/processcube_docflow popularity was classified as not 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 0 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.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.