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

Docusaurus customizations

Đang mở
#2,295 5 bình luận 2 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ệ
react
Lĩnh vực
documentation, frontend

Hướng nghiên cứu

Xem xét các thành phần theme tùy chỉnh trong src/theme/ và so sánh chúng với cấu trúc thành phần theme mới hơn của Docusaurus. Sử dụng các ví dụ về DocPage, DocItem, navbar, doc metadata và custom CSS được nêu trong issue làm các điểm thảo luận. Được xem là hoàn tất khi xác định được các nhu cầu tùy chỉnh cụ thể, có thể tái sử dụng và ghi lại những refactor hoặc tên class ổn định nào sẽ đáp ứng các nhu cầu đó.

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

Mô tả

structural

Hi there, I'm the Docusaurus maintainer.

Your site has interesting customizations, and I'd like to discuss those.

In particular, noticed the custom theme components implemented by @jaredcbaum here: https://github.com/ionic-team/ionic-docs/blob/main/src/theme/

Unfortunately, this requires the ejection of a bit too much internal code.

We are trying to make such customizations simpler over time, with less code to manage on your side, and would like to discuss such opportunities with you.

Note that for the next version, we refactored a few theme components. Many large components have been split into smaller ones, so that you can more easily intersperse your own components before/after the default ones.

Please take a look and let us know if any of your use-cases now become simpler to implement, and if some further refactors could help you.


Some random bits:

  • We really want to provide a system for custom navbar item types, but your workaround seem to work fine until then (https://github.com/facebook/docusaurus/issues/7227)

  • We could refactor DocPage to allow you to more easily add your custom doc navbar

  • We could refactor DocItem more to allow you to more easily change the layout and plug your demo sandbox

  • We could add the doc meta to a React context and provide the hook so that things like editUrl in TOC do not require an extra prop

Those are just examples, open to anything as long as it's not too specific to your site and reusable by others.

Also open to knowing better which custom CSS rules are fragile and for which we could provide more stable class names

Note that we have a dedicated issue to report customization use-cases: https://github.com/facebook/docusaurus/discussions/5468

Ngôn ngữ chính
MDX
Star
621
Fork
3.2k
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
86

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

Mở 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 ionic-team/ionic-docs

Tất cả issue của ionic-team/ionic-docs

Issue tương tự

Thêm issue về Documentation

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.