mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00

Files

Waylan Limberg a836155549 Add support for a 'dark mode' to mkdocs theme

Also add an optional toggle button for it.

Three new config options have been added:

1. 'color_mode' which can be set to one of 'light', 'dark', or 'auto'.
   Default is 'light' for backward compatability. The 'auto' color mode
   will check the system settings and automaticaly switch to light or
   dark mode on page load or when the system's color mode changes.
2. 'hljs_style_dark': the Highlight.js theme to use in 'dark_mode'.
   Default is 'github-dark' which matches the light mode default of
   'github'. The preexisting config option 'hljs_style' is used for
   'light' mode.
3. 'user_color_mode_toggle':
   Allow users to select their prefered color mode (light, dark, auto) from
   within the browser and save their preference for future page loads. The
   new config option 'user_color_mode_toggle' (default: 'False') can be
   enabled to display a toggle menu in the nav bar. The default value of the
   toggle menu on first load is the value set to 'color_mode'.

MkDocs' own documentation is now configured with 'color_mode: auto'.

Co-authored-by: Oleh Prypin <oleh@pryp.in>

2024-03-16 15:16:48 +01:00

choosing-your-theme.md

Add support for a 'dark mode' to mkdocs theme

2024-03-16 15:16:48 +01:00

cli.md

Add CLI reference page, auto-generated from Click (#2996 )

2022-10-08 11:17:05 +02:00

configuration.md

Apply new markdownlint rule table-pipe-style

2024-01-29 21:56:36 +01:00

customizing-your-theme.md

Consistently use ```text in Markdown

2024-03-16 14:49:04 +01:00

deploying-your-docs.md

Docs: add warning about uncommitted changes (#3034 )

2022-11-07 00:57:33 +01:00

installation.md

Replace instances of ```no-highlight

2022-09-19 22:22:33 +02:00

localizing-your-theme.md

Quote pip arguments containing square brackets (#3456 )

2023-11-01 17:20:14 +01:00

README.md

Add CLI reference page, auto-generated from Click (#2996 )

2022-10-08 11:17:05 +02:00

writing-your-docs.md

Use YAML indentation width of 2 spaces (#3287 )

2023-07-09 15:59:51 +02:00

README.md

User Guide

Building Documentation with MkDocs

The MkDocs Developer Guide provides documentation for users of MkDocs. See Getting Started for an introductory tutorial. You can jump directly to a page listed below, or use the next and previous buttons in the navigation bar at the top of the page to move through the documentation in order.