[Feature] Usage as a library
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- go
調査の方向性
README.md を読み、internal ディレクトリ下のパッケージを調査して、現在の目次およびリモート取得の動作を理解してください。Markdown ドキュメントから TOCs を生成するためのインポート可能なライブラリ API を定義し、文書化してください。この issue ではパッケージの境界や正確な API が指定されていないため、まずこれらの要件を明確にする必要があります。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
Outside of README.md, this tool could already be used on a variety of markdown documents to generate a table of contents. Unfortunately, customizing how to use the outputs would require importable packages outside the internal directory.
Describe the solution you'd like
A well documented API showing how to use the package as a library.
Describe alternatives you've considered
I've considered forking this library or writing my own. I apologize that I'm less likely to make a PR because I don't really need any of the remote fetching capabilities, so if I write the usage library feature, I'd be more likely to want to remove those parts.
Additional context
None
- 主要言語
- Go
- スター
- 525
- フォーク
- 90
- 平均マージ
- 2日 1時間
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ekalinin/github-markdown-toc.go のほかの issue
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
ekalinin/github-markdown-toc.go の issue をすべて見る
似ている issue
-
[Docs] - Document minimum Terraform/OpenTofu version (>= 1.11) required by write-only argumentsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 92/100
MagaluCloud/terraform-provider-mgc#323 ·
メンテナーはふだん 11 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
rossoctl/context-guru#366 ·
メンテナーはふだん 1 日以内に返信
-
stage-fail
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
siyuan-note/bazaar#2293 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
piraeusdatastore/piraeus-operator#1070 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信