Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Migrate To docgen.nvim

Đang mở
#3,330 1 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
lua
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu bằng cách xem xét dự án docgen.nvim được liên kết và thiết lập hiện tại của repository cho việc tạo tài liệu Neovim. Xác nhận các thành phần nội bộ LuaCATS và đầu ra được tạo ra tương ứng với nhau như thế nào, sau đó di chuyển dự án để tài liệu vẫn tương đương, đồng thời có thêm các liên kết tự động đến lớp và hàm như đã mô tả.

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

Mô tả

documentation

https://github.com/jamestrew/docgen.nvim is a documentation generator that is quite similar to Nvim's, using the same luacats internals. It's written by the telescope author and is under active development / use.

It generates documentation that is nearly the same, with a few QOL fixes such as automatic links to classes/functions.

This is desirable as Nvim's is not public API and has changed a few times e.g. https://github.com/nvim-tree/nvim-tree.lua/pull/3314

Ngôn ngữ chính
Lua
Star
8.7k
Fork
638
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
3

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

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 nvim-tree/nvim-tree.lua

Tất cả issue của nvim-tree/nvim-tree.lua

Issue tương tự

Thêm issue về Lua

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.