Skip to content

tinygo-org/tinygodoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages