Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Docusaurus customizations

オープン
#2,295 コメント 5 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
react

調査の方向性

src/theme/ 配下のカスタムテーマコンポーネントを確認し、新しい Docusaurus テーマコンポーネント構造と比較します。issue で挙げられている DocPage、DocItem、navbar、doc metadata、custom CSS の例を議論のポイントとして使用します。完了条件は、具体的で再利用可能なカスタマイズのニーズを特定し、それらに対応するリファクタリングまたは安定したクラス名を文書化することです。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
MDX
スター
621
フォーク
3.2k
平均マージ
1日 2時間
マージ済み PR(30日)
86

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ionic-team/ionic-docs のほかの issue

ionic-team/ionic-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。