Skip to content

Enable search plugin for mkdocs-material documentation#20

Merged
mahf708 merged 3 commits into
mainfrom
copilot/add-search-functionality
Jan 30, 2026
Merged

Enable search plugin for mkdocs-material documentation#20
mahf708 merged 3 commits into
mainfrom
copilot/add-search-functionality

Conversation

Copilot AI commented Jan 30, 2026

Copy link
Copy Markdown
Contributor

Search features were configured in the theme (search.suggest, search.highlight, search.share) but non-functional because the search plugin itself was missing from the plugins section.

Changes

  • Added search plugin to mkdocs.yml plugins section

When plugins are explicitly declared in mkdocs.yml, default plugins are disabled. The search plugin must be explicitly listed alongside the social plugin.

plugins:
  - search
  - social

This enables Lunr.js-based client-side search with autocomplete, highlighting, and result sharing across all documentation pages.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • fonts.google.com
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs build --strict --verbose (dns block)
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs build --verbose (dns block)
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs serve --dev-addr 0.0.0.0:8000 (dns block)
  • squidfunk.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>add search functionality</issue_title>
<issue_description></issue_description>

<agent_instructions>add search functionality through mkodcs material</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: mahf708 <122953255+mahf708@users.noreply.github.com>
Copilot AI changed the title [WIP] Add search functionality through mkodcs material Enable search plugin for mkdocs-material documentation Jan 30, 2026
Copilot AI requested a review from mahf708 January 30, 2026 16:16
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://E3SM-Project.github.io/aigroup/pr-preview/pr-20/

Built to branch gh-pages at 2026-01-30 16:25 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@mahf708 mahf708 marked this pull request as ready for review January 30, 2026 16:32
@mahf708 mahf708 enabled auto-merge (rebase) January 30, 2026 16:33
@mahf708 mahf708 disabled auto-merge January 30, 2026 16:33
@mahf708 mahf708 merged commit 9c7597a into main Jan 30, 2026
1 check passed
@mahf708 mahf708 deleted the copilot/add-search-functionality branch January 30, 2026 16:33
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.

add search functionality

2 participants