Docusaurus customizations
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- react
- Área
- documentation, frontend
Línea de trabajo
Revisa los componentes de tema personalizados de src/theme/ y compáralos con la estructura más reciente de componentes de tema de Docusaurus. Usa como puntos de discusión los ejemplos de DocPage, DocItem, navbar, doc metadata y custom CSS mencionados en el issue. Se considera terminado cuando se hayan identificado necesidades concretas y reutilizables de personalización y se haya documentado qué refactorizaciones o nombres de clase estables las abordarían.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
DocPageto allow you to more easily add your custom doc navbar -
We could refactor
DocItemmore 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
editUrlin 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
- Lenguaje dominante
- MDX
- Estrellas
- 621
- Forks
- 3.2k
- Merge medio
- 1 d 2 h
- PR fusionados (30 d)
- 86
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ionic-team/ionic-docs
-
content
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
ionic-team/ionic-docs#4705 ·
-
content package: angular
Dificultad 2/5 Medio día Aptitud para principiantes 78/100
ionic-team/ionic-docs#4702 ·
-
triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
ionic-team/ionic-docs#4546 ·
-
content: broken link Abiertocontent
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
ionic-team/ionic-docs#4381 · 2 comentarios ·
-
triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
ionic-team/ionic-docs#3639 ·
Todos los issues de ionic-team/ionic-docs
Issues similares
-
Area: Excel support
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
orbeon/orbeon-forms#7893 ·
-
Theme loads third-party resources on every page (jsdelivr web font, cdnjs Font Awesome) – GDPR Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comentario ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Claiming namespace: rasy007 Abiertonamespace operations
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
EclipseFdn/open-vsx.org#13419 ·