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

Theme management for static documentation #848

Open
martyanovandrey opened this issue Oct 16, 2024 · 0 comments
Open

Theme management for static documentation #848

martyanovandrey opened this issue Oct 16, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@martyanovandrey
Copy link
Contributor

Currently, our static documentation build supports both dark and light themes, along with a theme switcher. We'd like to enhance the configuration options in the .yfm file to give more control over theme management. Specifically, we need to add functionality to:

1. Disable the Light Theme and Theme Switcher:
Users should have the option to disable the light theme entirely, resulting in the removal of the theme switcher. This can be accomplished by setting the themes array to include only the 'dark' theme.

themes: ['dark']

2. Change the Default Theme:
Users should be able to change the default theme by specifying their preference at the start of the themes array. For example, if someone prefers the dark theme as default, they should configure the array like this:

themes: ['dark', 'light']

This ensures the dark theme loads by default while still allowing users to switch to the light theme.

Request:

  • Update the .yfm configuration setup to reflect these changes.
  • Ensure that the theme switcher can be conditionally disabled based on the presence of a single theme in the configuration.
  • Validate theme names to avoid typos that might cause configuration errors.
  • Add information about this change to the documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Development

No branches or pull requests

1 participant