site

Version:	org.nasdanika.models.app.cli@2025.2.0

Usage: nsd drawio html-app site [-hlV] [--progress-console] [--progress-data]
                                [--progress-json] [-b=<baseDir>]
                                [-F=<pageTemplateFile>] [-m=<domian>]
                                [-P=<parallelism>]
                                [--progress-output=<progressOutput>]
                                [-r=<pageErrors>] [-t=<timeout>]
                                [-T=<pageTemplate>] [-w=<workDir>]
                                [-x=<extension>] [-c=<String=String>]...
                                [-C=URL]... [-M=<String=String>]... [-e
                                [=<excludes>...]]... [-i[=<includes>...]]...
                                <output>
Generates HTML site
      <output>               Output directory relative to the base directory
  -b, --base-dir=<baseDir>   Base directory
  -c, --context-entry=<String=String>
                             Context entries.
                             Shadow entries in contexts and mounts.
  -C, --context=URL          Context resource URL relative to the current
                               directory. YAML, JSON, or properties. In
                               properties dots are treated as key path
                               separators. Type is inferred from the content
                               type header, if it is present, or extension.
                               Contexts are composed in the order of
                               definition, later context entries shadowing the
                               former
  -e, --exclude[=<excludes>...]
                             Output directory clean excludes
                             Ant pattern
  -F, --page-template-file=<pageTemplateFile>
                             Page template file relative
                             to the current directory
  -h, --help                 Show this help message and exit.
  -i, --include[=<includes>...]
                             Output directory clean includes
                             Ant pattern
  -l, --[no-]clean           Clean working directory
                             defaults to true
  -m, --domain=<domian>      Sitemap domain
  -M, --context-mount=<String=String>
                             MappingContext resource URL relative to the
                               current directory. YAML, JSON, or properties. In
                               properties dots are treated as key path
                               separators. Type is inferred from the content
                               type header, if it is present, or extension.
                               Mounts shadow context entries.
  -P, --parallelism=<parallelism>
                             If the value greater than one then an executor
                               service is created and injected into the context
                               to allow concurrent execution.
      --progress-console     Output progress to console
      --progress-data        Output progress data
      --progress-json        Output progress in JSON
      --progress-output=<progressOutput>
                             Output file for progress monitor
  -r, --errors=<pageErrors>  Expected number of page errors
                             -1 for any (not fail on errors)
                             default is 0
  -t, --timeout=<timeout>    If parallelism is greater than one this option
                               specifies timout in seconds awaiting completion
                               of execution. Default value is 60.
  -T, --page-template=<pageTemplate>
                             Page template URI relative
                             to the current directory
  -V, --version              Print version information and exit.
  -w, --work-dir=<workDir>   Working directory
  -x, --extension=<extension>
                             Extension of files to include in search
                             and site map. Defaults to html
Exit codes:
  Non-negative number   Delegate result
  -1                    Unhandled exception during execution
  -2                    Invalid input
  -3                    Diagnostic failed
  -4                    Execution failed or was cancelled, successful rollback
  -5                    Execution failed or was cancelled, rollback failed
  -6                    Executor service termination timed out

Example

drawio diagram.drawio html-app -r root-action.yml --add-to-root site -r=-1 -F page-template.yml docs

Grandparent drawio command loads diagram.drawio diagram resource
Parent html-app command generates an html application model from the diagram elements
This command:
- Loads a page template from page-template.yml
- Generates a documentation site ignoring page errors (-r=-1)
- Outputs the generated site to the docs directory

Options

-r, --errors

-r=-1 command line option means “don’t fail on page errors” such as:

Blank pages
Broken internal links
Missing resources

Missing resources are reported on pages using danger alert blocks.

If you want to prevent deployment of a site with page errors, don’t use the option or set it to the expected number of errors - there might be “known errors” which you are OK to live with.