@raycast/generate-docs

v0.8.23
This tool does a few things:

@raycast/generate-docs

This tool does a few things:

  • Check that all assets are indeed used in the docs
  • Check that all links lead somewhere
  • Replaces all instances of <InterfaceTableFromJSDoc name="..." /> by a markdown table generated from the JS Doc
  • Replaces all instances of <PropsTableFromJSDoc component="..." /> by a markdown table generated from the JS Doc

Usage

npx @raycast/generate-docs --docs=PATH/TO/DOCS/FOLDER --types=PATH/TO/TYPES/FILE.d.ts --output=PATH/TO/OUTPUT/FOLDER
npm i @raycast/generate-docs

Metadata

  • MIT
  • Whatever
  • mathieudutour
  • released 4/30/2024

Downloads