https://github.com/devlights/pkgdoc2md
pkg.go.devの特定パッケージページをMarkdownに変換するCLIツールです。LLMへのアップロード用途を想定して、ドキュメント本文のみを抽出します。
https://github.com/devlights/pkgdoc2md
go golang
Last synced: 13 days ago
JSON representation
pkg.go.devの特定パッケージページをMarkdownに変換するCLIツールです。LLMへのアップロード用途を想定して、ドキュメント本文のみを抽出します。
- Host: GitHub
- URL: https://github.com/devlights/pkgdoc2md
- Owner: devlights
- License: mit
- Created: 2026-04-21T05:37:05.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-21T06:02:08.000Z (about 2 months ago)
- Last Synced: 2026-04-21T07:32:56.791Z (about 2 months ago)
- Topics: go, golang
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pkgdoc2md
`pkg.go.dev` の特定パッケージページをMarkdownに変換するCLIツールです。
LLMへのアップロード用途を想定して、ドキュメント本文のみを抽出します。
HTMLからMarkdownへの変換には [html-to-markdown](https://github.com/JohannesKaufmann/html-to-markdown/tree/v1.6.0) を利用しています。
最新版の [html-to-markdown](https://github.com/JohannesKaufmann/html-to-markdown/tree/main) では GFM スタイルに変換するプラグインが無くなっているので、v1.6.0 を使ってます。
## インストール
```bash
go install github.com/devlights/pkgdoc2md@latest
```
## 使い方
```bash
# stdoutに出力
./pkgdoc2md -pkg net/http
# ファイルに出力
./pkgdoc2md -pkg net/http -output net_http.md
# タイムアウトを60秒に変更
./pkgdoc2md -pkg encoding/json -output encoding_json.md -timeout 60
# デバッグログを有効化
./pkgdoc2md -pkg context -debug
```
## フラグ
| フラグ | デフォルト | 説明 |
|-------------|------------|-------------------------------------------|
| `-pkg` | (必須) | 変換対象のパッケージパス (例: `net/http`) |
| `-output` | stdout | 出力先ファイルパス |
| `-timeout` | 30 | HTTPリクエストのタイムアウト秒数 |
| `-debug` | false | デバッグログを有効化 |