Skip to content

Switch to Modern DocFx Theme and Added Dark Mode#1773

Draft
pkbullock wants to merge 6 commits into
pnp:devfrom
pkbullock:dev-pkb-docfx
Draft

Switch to Modern DocFx Theme and Added Dark Mode#1773
pkbullock wants to merge 6 commits into
pnp:devfrom
pkbullock:dev-pkb-docfx

Conversation

@pkbullock

Copy link
Copy Markdown
Member
  • Switching theme, greatly reduces theme complexity and contains alot of the features built in e.g. dark mode, clipboard etc. and uses Bootstrap V5
  • Formatting tailored to the red theme, checked in light and dark modes.
  • Uses DotNet tools for DocFx
  • Added local build script (instructions inside and will seek to document in the repo)

Closes #1716

Example of new Theme:

image image

--

Copilot Summary

This pull request introduces significant improvements to the documentation site's theming, including the addition of a dark mode toggle, enhancements to the CSS for both light and dark themes, and updates to the DocFX configuration and build process. The changes modernize the site's appearance, provide users with a theme-switching option, and streamline the local documentation build experience.

Theming and UI Enhancements:

  • Added a dark mode theme with comprehensive CSS variable support for both light and dark themes, including colors for backgrounds, code blocks, and alerts. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]
  • Introduced a theme toggle button in the navbar, allowing users to switch between light and dark modes. [1] [2] [3]
  • Refined and expanded the CSS for the documentation site, including new styles for headings, navigation, alerts, images, code highlighting, and responsive design.

DocFX Configuration and Build Process:

  • Switched DocFX installation to a .NET tool, including a new .config/dotnet-tools.json for tool management and a PowerShell script (docfx-build-local.ps1) to streamline local builds. [1] [2]
  • Updated docfx.json to include the "modern" template and adjusted the footer to reference the "Material Modern UI" theme. [1] [2]

File Organization:

These updates collectively provide a more modern, user-friendly, and customizable documentation experience.

@Adam-it

Adam-it commented May 31, 2026

Copy link
Copy Markdown
Member

Dark mode 😍🤩

@Adam-it Adam-it self-assigned this May 31, 2026

@Adam-it Adam-it left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@pkbullock awesome work 👏👏👏
While testing around I noticed a few details I think it would be cool to fixup before we proceed

  1. The most critical thing is that it seems the sample page does not load
Image
  1. When minimazing the size it seems we have some width that it starts to look bad but does not jump to the small size menu, it seems the old docs page does a better jump here
Image

Also for small screen manu button I think the hamburger was bettern than the dots

Image Image
  1. I know it was like this before but could we along the way adda a favicon for our docs
Image

Comment on lines +251 to +262
/* @media (min-width: 768px) {
#autocollapse .navbar-toggle {
display: none !important;
}

#autocollapse .navbar-collapse.collapse {
display: block !important;
height: auto !important;
overflow: visible !important;
padding-bottom: 0;
}
} */

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

maybe if this is not needed we could just remove this part

@Adam-it Adam-it marked this pull request as draft June 2, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refresh DocFx Engine - Up to latest

2 participants