Ich habe ein kleines Go-Programm geschrieben, und ich möchte eigenständige HTML-Dokumente aus Quellcode generieren, die ohne Godoc-Server angezeigt werden können. Aber ich kann keinen Weg finden, es zu erreichen. Wenn mir jemand helfen könnte, werde ich es zu schätzen wissen.Wie kann ich HTML-Dokumente mit `godoc` erzeugen?
Eine einfache HTML-Dokumentation kann zum Beispiel hergestellt werden:
$ godoc -html container/heap Interface > page.html
Ein Bit kann bessere Form von Produktion: 6060 und I:
$ godoc -url "http://localhost:6060/pkg/container/heap/" > page.html
(I godoc Server am Laufen haben bin mir nicht sicher, ob das eine Voraussetzung ist.
Der HTML-Code würde wahrscheinlich besser aussehen, wenn er mit den ursprünglichen CSS-Stilen im Go-Repository kombiniert wird, indem die erzeugten HTML-Dateien entsprechend angepasst werden.
Dies beantwortet möglicherweise nicht direkt Ihre Frage, aber wenn Sie planen, Ihr Projekt zu öffnen, müssen Sie HTML nicht wirklich manuell generieren. Stellen Sie nur sicher, dass Sie Kommentare richtig in Ihren Quellcode eingefügt haben, und verwenden Sie godoc.org (http://godoc.org/-/about), um damit umzugehen.
Es zeigt Dokumentation für Go-Pakete auf Bitbucket, Github, Launchpad und Google Project Hosting.
dies prüft zum Beispiel aus: http://godoc.org/code.google.com/p/go.crypto/ssh
Danke, ich war überrascht, als ich das Dokument meines Pakets auf godoc fand! – pltvs
keine Voraussetzung für einen echten Server und ein 'godoc -url„/ pkg/Container/Haufen /“> page.html' würde genügen – FiloSottile
Es gibt eine Änderungsanforderung offen Füge Unterstützung für das Generieren einer statischen Website hinzu https://github.com/golang/go/issues/2381#issuecomment-342043987 – dnephin