Proposal: Add options to use pre-processed content with `beforeEach` function
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
- tooling
Hướng nghiên cứu
Bắt đầu bằng việc xem xét các giai đoạn render của docsify và tích hợp của nó với Marked, sau đó thảo luận về vòng đời được đề xuất với các maintainer của dự án vì issue không chỉ rõ API hay vị trí triển khai. Công việc được coi là hoàn tất khi có một preprocessing hook không phá vỡ tính tương thích đã được thống nhất, hành vi được ghi lại trong tài liệu và các bài kiểm thử bao quát thứ tự xử lý plugin cũng như việc tái sử dụng nội dung đã được tiền xử lý.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Feature request
What problem does this feature solve?
For plugins, we have to do some pre-processing tasks, for example, we always need to ignore the code blocks, then start the processing of our plugins.
If this function not provided by docsify itself officially, then each plugin need to handle it by themselves, for users who want included many plugins, those pre-processing tasks will be executed repeatedly, which will affect the performance for loading pages.
What does the proposed API look like?
Haven't yet considered welly, but might can consider adding something like afterEachXXX for each stage of processing the markdown content, like afterEachCodeHandled.
I hope it should be a “new feature”, rather than a “break change”.
How should this be implemented in your opinion?
Haven't yet considered welly, waiting for project members to discuss this proposal, since docsify does not handle the render stages by itself other than using Marked.
Are you willing to work on this yourself?
Might will have some time to do this, but need helps and advices.
- 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
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của docsifyjs/docsify
-
Query parameter values are truncated at a second equals signCó thể đã có người làm @xu91102 đã nhận 23 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 8 ngày
-
Bullet points beginning with inline math: subsequent text formatting not recognised correctlyĐang mởbug Triage
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 8 ngày
-
Cached AJAX responses lose status metadata exposed through vm.route.responseCó thể đã có người làm @xu91102 đã nhận 23 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 8 ngày
-
In the Edge browser, the character `{docsify-updated}` is not replacedCó thể làm lại được @AmanUllah687 đã nhận 76 ngày trước và không có pull request nào đang mở. Đang mởwait for information
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
docsifyjs/docsify#2681 · 11 bình luận ·
Maintainer thường phản hồi trong vòng 8 ngày
-
Nested/Recursive includesĐang mởfeature request Triage
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 38/100
docsifyjs/docsify#2643 · 5 bình luận ·
Maintainer thường phản hồi trong vòng 8 ngày
Tất cả issue của docsifyjs/docsify
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
subhranshudash13-dotcom/Contribo#74 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 67/100
ThatGuySam/doesitarm#1114 ·
-
enhancement good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
laaielichter/Reverseport#44 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
failed for an unknown reason
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
OpenTermsArchive/contrib-declarations#4148 ·
Maintainer thường phản hồi trong vòng 1 ngày