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

Encapsulating Docsify

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

Maintainer thường phản hồi trong vòng 8 ngày

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ệ
javascript
Lĩnh vực
frontend, web-dev

Hướng nghiên cứu

Bắt đầu bằng cách đọc checklist về tính đóng gói và các thay đổi lớp liên quan được tham chiếu trong #2104. Lập bản đồ các yêu cầu về thanh tiến trình, định tuyến và trạng thái ở cấp module, sau đó xác định việc hoàn thành là hỗ trợ vị trí thanh tiến trình có thể cấu hình, định tuyến ảo và định tuyến được điều khiển từ bên ngoài tùy chọn, cùng trạng thái theo từng instance mà không phá vỡ các giá trị mặc định.

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

Mô tả

We need allow the ability to fully encapsulate Docsify features and state.

With encapsulation, it will be possible later on to mount any number of Docsify instances anywhere in a web site, as well as become possible to wrap Docsify as a React/Vue/Svelte/etc component that can be used in any framework.

Encapsulation changes:

  • progress bar currently appends to body. There should be an option to provide the location where it should be appended. It can default to body for backwards compatibility.
  • Routing: it currently assumes control of the address bar. For backwards compatibility, this can be the default.
    • We need an option to make it route virtually, without touching the address bar, for cases when that is desirable
    • Perhaps add the ability to listen to a Docsify instance's route changes, so that they can be mapped to the address bar in a custom way. Also allow setting Docsify's route from outside, so that a website managing multiple instances can "paginate" Docsify manually.
  • Some Docsify state is at the module level (singleton), including the aforementioned progress bar, but also including state variables. We should bring state into the Docsify class. Some of this this in #2104 in the items where we're bringing some functions into the classes as private methods.
Ngôn ngữ chính
JavaScript
Star
31.5k
Fork
5.8k
Merge trung bình
7 ngày 18 giờ
Pull request đã merge (30 ngày)
9

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 docsifyjs/docsify

Tất cả issue của docsifyjs/docsify

Issue tương tự

Thêm issue về JavaScript

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.