{"id":16938584,"url":"https://github.com/dsnet/godoc","last_synced_at":"2025-04-11T19:14:09.637Z","repository":{"id":57581028,"uuid":"358393505","full_name":"dsnet/godoc","owner":"dsnet","description":null,"archived":false,"fork":false,"pushed_at":"2021-05-01T00:22:06.000Z","size":136,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T19:14:04.030Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-15T21:10:32.000Z","updated_at":"2024-01-15T00:23:11.000Z","dependencies_parsed_at":"2022-09-26T19:30:59.372Z","dependency_job_id":null,"html_url":"https://github.com/dsnet/godoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsnet%2Fgodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsnet%2Fgodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsnet%2Fgodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsnet%2Fgodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsnet","download_url":"https://codeload.github.com/dsnet/godoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248465345,"owners_count":21108244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T21:01:07.317Z","updated_at":"2025-04-11T19:14:09.619Z","avatar_url":"https://github.com/dsnet.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GoDoc HTML Renderer #\n\n## Introduction ##\n\nThis module provides the `godoc` tool that renders HTML for Go documentation.\nThe purpose of this tool is to experiment with proposed GoDoc features.\n\n## Installation ##\n\nThe `godoc` tool can be installed by running:\n```\ngo install github.com/dsnet/godoc@latest\n```\n\n## Usage ##\n\nNavigate to within a module that you would like rendered and invoke the `godoc` tool.\nThe tool will serve Go documentation for all packages (including transitively reachable packages) within that module.\nThis tool only works with Go modules.\n\nThe `godoc` tool can be run in one of two modes:\n\n1.  **Serve mode**: In serve mode (the default), `godoc` starts up an HTTP server\n    that serves webpages of Go documentation. When the server starts,\n    it prints the URL for the current package or module.\n\n    Example usage:\n    ```\n    $ cd $PROTOBUF_MODULE  # or any other module directory\n    \n    $ godoc -serve=0.0.0.0:8080\n    http://0.0.0.0:8080/google.golang.org/protobuf\n    ```\n\n2. **Archive mode**: In archive mode (which is specified using the \"-archive\" flag),\n    `godoc` emits a TAR archive of statically generated HTML files.\n\n    Example usage:\n    ```\n    $ cd $PROTOBUF_MODULE  # or any other module directory\n    \n    $ OUTPUT_DIRECTORY=out\n    $ mkdir $OUTPUT_DIRECTORY\n    $ godoc -archive=- | tar -x --directory $OUTPUT_DIRECTORY\n    main.go:117: rendering \"\"\n    main.go:117: rendering \"archive\"\n    main.go:117: rendering \"archive/tar\"\n    main.go:117: rendering \"archive/zip\"\n    main.go:117: rendering \"bufio\"\n    main.go:117: rendering \"builtin\"\n    main.go:117: rendering \"bytes\"\n    ...\n\n    $ cd $OUTPUT_DIRECTORY\n    $ python -m SimpleHTTPServer\n    Serving HTTP on 0.0.0.0 port 8000 ...\n    ```\n\n    The example above emits a TAR archive to stdout,\n    which we immediately extract into some output directory.\n    Afterwards, we change the working directory into the output directory and\n    use Python's SimpleHTTPServer module to serve the statically generated files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsnet%2Fgodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsnet%2Fgodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsnet%2Fgodoc/lists"}