goboscript icon indicating copy to clipboard operation
goboscript copied to clipboard

auto-generate documentation for reporters and blocks from gdsl.txt

Open aspizu opened this issue 1 year ago • 2 comments

aspizu avatar Oct 07 '24 17:10 aspizu

i guess i could try this today. i now know how material for mkdocs works. also i think it may be a good idea to host docs on the goboscript org. that way you get a nicer url of just goboscript.github.io instead of aspizu.github.io/goboscript

faretek1 avatar Sep 12 '25 15:09 faretek1

I made a pretty primitive thing: https://inflated-goboscript.github.io/goboscript-gdsl

The script docgen/main.py generates the markdown which the gh pages uses.

Not sure exactly how it should be formatted though. It uses python's str.format, using md files in the doc_templates directory as templates, so it should be easy enough to customize.

One feature that I think would be ideal is the separation of blocks into categories. There could be a new md file for looks, motion, pen, control, etc, which all live in a docs/blocks directory.

faretek1 avatar Sep 12 '25 19:09 faretek1