[Feature] Usage as a library

Đang mở
  • Có gì không ổn?
#56 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
go
Lĩnh vực
api, developer-experience

Hướng nghiên cứu

Đọc README.md và kiểm tra các package trong thư mục internal để hiểu hành vi hiện tại của mục lục và việc lấy dữ liệu từ xa. Xác định và lập tài liệu cho một API thư viện có thể import để tạo TOC từ các tài liệu Markdown; issue không chỉ rõ ranh giới package hoặc API chính xác, vì vậy trước tiên cần làm rõ các yêu cầu đó.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

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

Ngôn ngữ chính
Go
Star
525
Fork
89
Merge trung bình
6 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ekalinin/github-markdown-toc.go

Tất cả issue của ekalinin/github-markdown-toc.go

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.