freeCodeCamp / freeCodeCamp/devdocs

Cleaner HTML

Đang mở
#1,179 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
docs/improvement improvement
Ngôn ngữ chính
Ruby
Star
39.5k
Fork
2.6k
Merge trung bình
4 ngày 32 phút
Pull request đã merge (30 ngày)
13

Mô tả

Ideally, scraped docs would have minimal HTML. However, several docs currently have classes and wrapper elements. There should be a check that can be run after docs are scraped that looks for elements with a `class` or other non-`id` attribute that isn’t referenced by a CSS selector, as well as non-semantic elements with no attributes that are not referenced in the CSS. Then, someone should go through all of the docs to find and eliminate the excess markup. This will most likely result in a decrease in the size of downloaded docs bundles.

- [ ] create linter
- [ ] lint & fix the docs (maybe only do this when updating a doc for other reasons)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách truy vết nơi HTML được scrape được tạo ra và nơi các bộ chọn CSS của tài liệu được định nghĩa. Xây dựng bước kiểm tra sau khi scrape được yêu cầu cho các class không được sử dụng, các thuộc tính không phải id và các phần tử phi ngữ nghĩa không có thuộc tính, sau đó chạy nó trên toàn bộ tài liệu và xóa phần markup dư thừa được báo cáo. Hoàn thành có nghĩa là linter hoạt động và tài liệu vượt qua bước kiểm tra đó.

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

Đánh giá

Công nghệ
css, html, ruby
Lĩnh vực
documentation, tooling
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

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.