npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@5minds/processcube_docflow

v1.3.3

Published

Create static webpage to view process documentation

Downloads

151

Readme

ProcessCube DocFlow

Description

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.

Usage

  1. Have your BPMN diagrams in a processes directory.
  2. Optional: Have a README.md file in the root directory of your project.

with NPM

  1. Run npm i -g @5minds/processcube_docflow in the root directory of your project to install the package.
  2. Run docflow build to generate the documentation website.
  3. Run docflow serve to start the server.
  4. Visit http://localhost:3000 in your browser.

with Docker

  1. Run
docker run -p 3000:3000 -t -i -v ./processes:/src/processes -v ./README.md:/src/README.md 5minds/processcube_docflow
  1. Visit http://localhost:3000 in your browser.

Options

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 Routing
  • PROCESSES_DIR: Custom path for processes
  • README_PATH: Custom path to a README.md

Development

If you want to develop and test the package locally, you can do the following:

  1. Clone the repository.
  2. Run npm i to install the dependencies.
  3. Run npm link to link the package. docflow should be available now.
  4. Use the package as described in the usage section.

Running in the CI

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