Skip to content

Add docs generator command for extension authors #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
riknoll opened this issue Jan 22, 2025 · 1 comment
Open

Add docs generator command for extension authors #127

riknoll opened this issue Jan 22, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@riknoll
Copy link
Member

riknoll commented Jan 22, 2025

i would love to have a command that takes JSDoc from extension APIs and generates markdown files for all exported blocks in the format described here: https://makecode.com/extensions/github-docs

it should:

  1. find all APIs with //% block (can skip deprecated blocks)
  2. have an option to automatically add the //% help="" annotation since it always confuses everyone
  3. add empty JSDoc with all the params to the API if it doesn't already exist
  4. create a markdown file inside a docs/ folder if it doesn't exist
  5. populate that markdown file with the contents of the JSDoc (if present)

all of these options/steps should be controllable with flags

@riknoll riknoll added the enhancement New feature or request label Jan 22, 2025
@pelikhan
Copy link
Member

also generate the jsdoc/block string json files using mkc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants