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

Enable Just the Docs dark color scheme #29

Open
KeenanLukeOM opened this issue Feb 11, 2021 · 3 comments · May be fixed by #42 or #46
Open

Enable Just the Docs dark color scheme #29

KeenanLukeOM opened this issue Feb 11, 2021 · 3 comments · May be fixed by #42 or #46
Assignees
Labels
enhancement New feature or request

Comments

@KeenanLukeOM
Copy link
Collaborator

Found in customization: https://pmarsceill.github.io/just-the-docs/docs/customization/

Just the Docs supports two color schemes: light (default), and dark.

To enable a color scheme, set the color_scheme parameter in your site’s _config.yml file:

Attempt to enable this in our document book. If there is no initial issues with this, we should run with it. Otherwise, ignore this issue and close it.

@KeenanLukeOM KeenanLukeOM added the enhancement New feature or request label Feb 11, 2021
@Mi-Lan
Copy link
Owner

Mi-Lan commented Feb 17, 2021

@KeenanLukeOM Good suggestion! Where should we put the button for switching?

@KeenanLukeOM
Copy link
Collaborator Author

If a button makes sense, it would likely be above or replacing "This site uses Just the Docs, a documentation theme for Jekyll.". This could be tricky to implement.

I do think that the docs styling could stay consistently in darkmode without an option to switch without any issue though.

@KeenanLukeOM
Copy link
Collaborator Author

As mentioned today, let's attempt to implement a dark mode toggle in place of "This site uses Just the Docs, a documentation theme for Jekyll."

image

@Mi-Lan Mi-Lan linked a pull request Mar 4, 2021 that will close this issue
@Mi-Lan Mi-Lan linked a pull request Apr 20, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants