Package Exports

@virmator/docs
@virmator/docs/dist/docs.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@virmator/docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@virmator/docs

A default plugin for virmator.

Available commands

docs

Generates documentation using the typedoc package and inserts code examples into README files using the markdown-code-example-inserter package.
- Examples
  - virmator docs
- Configs
  - configs/typedoc.config.ts
- Deps
  - markdown-code-example-inserter
  - typedoc
- Sub Commands
  - check
    
    Checks that documentation is valid and passes all checks without generating documentation outputs.
    - Examples
      - virmator docs check