Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Docusaurus customizations

Open
#2,295 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
react
Domain
documentation, frontend

Research direction

Review the custom theme components under src/theme/ and compare them with the newer Docusaurus theme component structure. Use the DocPage, DocItem, navbar, doc metadata, and custom CSS examples named in the issue as discussion points. Done means identifying concrete, reusable customization needs and documenting which refactors or stable class names would address them.

Written by the indexing model from the issue text.

Description

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

Dominant language
MDX
Stars
621
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
86

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ionic-team/ionic-docs

All issues in ionic-team/ionic-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.