https://github.com/bradleyjkemp/godoc-playground
Play with GoDoc syntax and preview your changes in realtime
https://github.com/bradleyjkemp/godoc-playground
go godoc playground preview
Last synced: 7 months ago
JSON representation
Play with GoDoc syntax and preview your changes in realtime
- Host: GitHub
- URL: https://github.com/bradleyjkemp/godoc-playground
- Owner: bradleyjkemp
- License: mit
- Created: 2018-10-14T18:50:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-28T17:10:11.000Z (about 6 years ago)
- Last Synced: 2025-02-27T16:43:59.057Z (7 months ago)
- Topics: go, godoc, playground, preview
- Language: Go
- Homepage: https://bradleyjkemp.github.io/godoc-playground
- Size: 2.51 MB
- Stars: 113
- Watchers: 5
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoDoc Playground ([visit](https://bradleyjkemp.github.io/godoc-playground))
![]()
The GoDoc Playground lets you make changes to your packages documentation and see, in (near) realtime, exactly how this will be rendered on [godoc.org](https://godoc.org).
## Features
* Automagically fixes unresolved symbols so you don't need to paste in all your code, just a small snippet.
* Uses the actual godoc library to parse and render documentation so you can be confident your documentation will be rendered exactly as previewed.
* Completely in-browser: uses a GopherJS compiled parser/renderer so your code never leaves the browser. Even works offline!