JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q21629F
  • License MIT

Utility for generating documentation from aframe-typescript projects

Package Exports

  • aframe-typescript-docs-generator
  • aframe-typescript-docs-generator/dist/main.mjs

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 (aframe-typescript-docs-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A-Frame TypeScript Docs Generator

npm version npm version github twitter mastodon ko-fi

This project generated beautiful documentation from your A-Frame TypeScript projects. You can add rich documentation directly in your code using TSDoc. The generator uses TypeDoc to extract documentation and then outputs corresponding markdown files compatible with MkDocs.

Example

See the reference documentation of aframe-locomotion for an example of generated docs using this project: https://aframe-locomotion.fern.solutions/reference/