@raycast/generate-docs

0.8.23 • Public • Published

@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

Readme

Keywords

none

Package Sidebar

Install

npm i @raycast/generate-docs

Weekly Downloads

0

Version

0.8.23

License

MIT

Unpacked Size

34 kB

Total Files

9

Last publish

Collaborators

  • rso
  • samuelkraft
  • thomlom
  • sxn
  • mathieudutour
  • pitnikola
  • felix.rc
  • raycastbot
  • grzegorzkrukowski_raycast
  • thomaspaulmann