Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.48 KB

File metadata and controls

28 lines (24 loc) · 1.48 KB

tinygodoc

go.dev reference Go Report Card codecov Go sourcegraph License: BSD-3

Browse tinygo APIs easily. Above is the HTTP server for browsing different APIs among targets, with the ADC type selected. The number to the right of the API is the amount of times it appears in documentation.

To run with tinygo in the same folder as tinygodoc:

go run ./cmd/tgdoc -http=:18080 ../tinygo/targets ../tinygo/src/machine 

Front page of the tgdoc tool showing two modes of browsing, one by target and one by identifier

Usage of tgdoc:
  -all
        include unexported identifiers
  -base
        include base/parent targets
  -http string
        serve HTTP documentation (e.g. :8080)
  -json
        output JSON to stdout