2
Gibt es eine Möglichkeit, Bilder (lokal oder remote) zu der HTML-Version godoc generiert hinzuzufügen?Bilder in godoc?
Dies ist sehr nützlich für Diagramme, die einfach nicht mit Worten erklärt werden können.
A
Antwort
4
Das Godoc-Tool bietet keine Möglichkeit, Bilder zur Dokumentation hinzuzufügen.
godoc unterstützt es nicht. Das gegenwärtige/Artikelformat macht mit .image; Das Format ist unter https://godoc.org/golang.org/x/tools/present beschrieben und z.B. https://godoc.org/golang.org/x/tools/blog verwendet es für Nicht-Präsentationsblogartikel. Aber sobald du deine Dokumentation außerhalb von godoc vervollständigst, macht es vielleicht mehr Sinn, Markdown zu schreiben und Hugo oder GitHub es zu rendern oder HTML zu schreiben. (Im Godoc können Sie immer die URL von Bildern oder Außenseiten einfügen.) – twotwotwo
Es lohnt sich zu bemerken, dass Godoc im Grunde eine Paketreferenz ist, und viel untriviale Software, einschließlich Go, hat eine Menge anderer Dokumentation es außerhalb der Paketreferenz. – twotwotwo
Am nächsten zu Bildern ist ASCII-Art in Codeblöcken (was in Ordnung für nicht zu große Diagramme funktioniert). – Volker