{"id":20206013,"url":"https://github.com/rillig/go-codewalk","last_synced_at":"2026-02-03T23:03:08.175Z","repository":{"id":75507697,"uuid":"223827489","full_name":"rillig/go-codewalk","owner":"rillig","description":"Simple markup format for documenting code","archived":false,"fork":false,"pushed_at":"2024-12-12T23:44:41.000Z","size":20,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-21T23:43:00.531Z","etag":null,"topics":["golang","literate-programming"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rillig.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-24T23:48:21.000Z","updated_at":"2024-12-12T23:44:45.000Z","dependencies_parsed_at":"2024-06-21T16:49:01.176Z","dependency_job_id":"9b367fa5-ce61-4925-b6a0-6ede6a4aa8ab","html_url":"https://github.com/rillig/go-codewalk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rillig/go-codewalk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rillig%2Fgo-codewalk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rillig%2Fgo-codewalk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rillig%2Fgo-codewalk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rillig%2Fgo-codewalk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rillig","download_url":"https://codeload.github.com/rillig/go-codewalk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rillig%2Fgo-codewalk/sbom","scorecard":{"id":776623,"data":{"date":"2025-08-11","repo":{"name":"github.com/rillig/go-codewalk","commit":"b1017d19e40cdbc3c84bba3d8422412a1d49cf21"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 1/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T03:47:54.470Z","repository_id":75507697,"created_at":"2025-08-23T03:47:54.470Z","updated_at":"2025-08-23T03:47:54.470Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29060635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T22:28:58.191Z","status":"ssl_error","status_checked_at":"2026-02-03T22:28:56.515Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["golang","literate-programming"],"created_at":"2024-11-14T05:20:38.795Z","updated_at":"2026-02-03T23:03:08.158Z","avatar_url":"https://github.com/rillig.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codewalk\n\nThe Go standard library provides so-called codewalks, which are navigable\ndocuments that refer to source code of the project and serve as an\nintroduction to the code.\n\nUnfortunately they are limited to the Go standard library and cannot be\nused for third-party code. Therefore I wrote this alternative, using Markdown\nas the primary markup language instead of XML.\n\nThere are two documents in this folder: [README.src.md](README.src.md)\ncontains the source code of the codewalk, while [README.md](README.md)\ncontains the documentation generated from that file. It is generated\nusing this command:\n\n~~~shell script\ncodewalk README.src.md README.md\n~~~\n\nTo include a code snippet in the document, add a block like the following:\n\n    ```codewalk\n    file    codewalk.go\n    start   ^func Name\n    end     ^}\n    endUp   5\n    go:func FunctionName\n    go:func -no-doc -no-body Type.Method\n    go:type -no-doc -no-body Type\n    ```\n\nEach line in the above block is a command. The above commands are just a\nsummary and cannot all be combined. To get an idea about the possibilities,\nhere is the type definition of a code block:\n\n\u003e from [codewalk.go](codewalk.go#L15):\n\n```go\ntype block struct {\n\tlines   []string\n\tsnippet *snippet\n}\n```\n\nThe lines of a block are contiguous, though it would be possible to add\nsome \"grep\" feature, to only show matching lines.\n\nWhen a block is parsed, its `snippet` field gets filled. Its definition is:\n\n\u003e from [codewalk.go](codewalk.go#L20):\n\n```go\ntype snippet struct {\n\tfile  string\n\tstart int // inclusive\n\tend   int // inclusive\n}\n```\n\nHere it becomes obvious that the commands of a `codewalk` block in the\nMarkdown document can only manipulate the start and end line of the block.\n\nTo see a more complete example file, have a look at the codewalk of the\n[pkglint](https://github.com/rillig/pkglint/blob/master/v23/codewalk.md) project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frillig%2Fgo-codewalk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frillig%2Fgo-codewalk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frillig%2Fgo-codewalk/lists"}