Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: setup docusaurus EUI theme #7827

Merged
merged 5 commits into from
Jun 18, 2024

Conversation

tkajtoch
Copy link
Member

Summary

Resolves #7645.

This PR creates a new docusaurus-theme package that will be the upcoming EUI theme for Docusaurus. It moves all existing docusaurus component overrides that were in packages/website/src/theme to the new package and configures it following the other official docusaurus packages.

@tkajtoch tkajtoch self-assigned this Jun 11, 2024
@@ -0,0 +1,47 @@
import { css } from '@emotion/react';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an example component override to show how to work with Emotion, Docusaurus and EUI. It shouldn't be considered final - the styles don't work great on mobile screens.

@@ -0,0 +1,68 @@
{
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is based on docusaurus' base tsconfig to keep the theme 100% compatible with it

@tkajtoch tkajtoch force-pushed the feat/setup-docusaurus-theme branch from 7da45ed to d58d07c Compare June 17, 2024 23:48
@tkajtoch tkajtoch marked this pull request as ready for review June 17, 2024 23:49
@tkajtoch tkajtoch requested a review from a team as a code owner June 17, 2024 23:49
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 🎉 The setup looks good to me. I ran it locally and didn't encounter any issues.
I will go ahead and merge this PR as it's the base for any further EUI+ work.

@mgadewoll mgadewoll merged commit 30a6c92 into elastic:main Jun 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New docs] Setup the custom docusaurus EUI theme as a separate package
4 participants