No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 
 

73 líneas
3.0 KiB

  1. {{define "Head"}}<title>About - GoDoc</title>{{end}}
  2. {{define "Body"}}
  3. <h1>About</h1>
  4. <p>GoDoc hosts documentation for <a href="http://golang.org/">Go</a>
  5. packages on <a href="https://bitbucket.org/">Bitbucket</a>, <a
  6. href="https://github.com/">GitHub</a>, <a
  7. href="https://launchpad.net/">Launchpad</a> and <a
  8. href="http://code.google.com/hosting/">Google Project Hosting</a>.
  9. <p>The source code for GoDoc is available <a
  10. href="https://github.com/golang/gddo">on GitHub</a>.
  11. <p>GoDoc displays documentation for GOOS=linux unless otherwise noted at the
  12. bottom of the documentation page.
  13. <h4 id="howto">Add a package to GoDoc</h4>
  14. <p>GoDoc generates documentation from Go source code. The <a
  15. href="http://blog.golang.org/godoc-documenting-go-code">guidelines</a>
  16. for writing documentation for the <a
  17. href="http://golang.org/cmd/godoc/">godoc</a> tool apply to GoDoc.
  18. <p>It's important to write a good summary of the package in the first sentence
  19. of the package comment. GoDoc indexes the first sentence and displays the first
  20. sentence in package lists.
  21. <p>To add a package to GoDoc, <a href="/">search</a> for the package by import
  22. path. If GoDoc does not already have the documentation for the package, then
  23. GoDoc will fetch the source from the version control system on the fly and add
  24. the documentation.
  25. <p>GoDoc checks for package updates once per day. You can force GoDoc to update
  26. the documentation immediately by clicking the refresh link at the bottom of the
  27. package documentation page.
  28. <p>GoDoc crawls package imports and child directories to find new packages.
  29. <h4 id="remove">Remove a package from GoDoc</h4>
  30. GoDoc automatically removes packages deleted from the version control system
  31. when GoDoc checks for updates to the package. You can force GoDoc to remove a
  32. deleted package immediately by clicking the refresh link at the bottom of the
  33. package documentation page.
  34. If you do not want GoDoc to display documentation for your package, send mail
  35. to golang-dev@googlegroups.com with the import path of the path of the package
  36. that you want to remove.
  37. <h4 id="feedback">Feedback</h4>
  38. <p>Send your ideas, feature requests and questions to the <a href="https://groups.google.com/group/golang-dev">golang-dev mailing list</a>.
  39. Report bugs using the <a href="https://github.com/golang/gddo/issues/new">GitHub Issue Tracker</a>.
  40. <h4 id="shortcuts">Keyboard Shortcuts</h4>
  41. <p>GoDoc has keyboard shortcuts for navigating package documentation
  42. pages. Type '?' on a package page for help.
  43. <h4 id="bookmarklet">Bookmarklet</h4>
  44. <p>The GoDoc bookmarklet navigates from pages on Bitbucket, GitHub Launchpad
  45. and Google Project Hosting to the package documentation. To install the
  46. bookmarklet, click and drag the following link to your bookmark bar: <a
  47. href="javascript:window.location='http://{{.Host}}/?q='+encodeURIComponent(window.location)">GoDoc</a>
  48. <h4>More Documentation</h4>
  49. <p>More documentation about GoDoc is available on <a href="https://github.com/golang/gddo/wiki">the project's GitHub wiki</a>.
  50. {{end}}