跳转至

🔍 搜索内容

Search & tables of content

Built-in MkDocs search plugin.

fastsearch

Fork of the built-in search plugin that excludes code blocks and tables, which becomes necessary when hosting notebooks and other large content.

  • author: Andy Oakley andyoakley
  • links: GitHub | Docs
  • installation: pip install git+https://github.com/andyoakley/mkdocs-fastsearch

localsearch

PyPI - Downloads

A MkDocs plugin to replace the native “search” plugin with a search plugin that also works locally (file:// protocol). This plugin currently only works with the Material for MkDocs theme.

PyPI - Downloads

Lets you exclude selected files or sections from the search index, results will not show up in the search.

  • author: chrieke
  • links: GitHub | PyPI
  • installation: pip install mkdocs-exclude-search

tags

Support for tags in the yaml-metadata in the header of markdown files. Extracts this metadata and creates a “Tags” page which lists all tags and all pages for each tag. The metadata has to be enclosed in --- lines, and must include a title: property (otherwise the page will appear as “untitled” in the tags page).

---
title: Welcome
tags:
  - testing
  - unimportant
---

# Welcome to MkDocs
  • author: jldiaz
  • links: Github | Docs
  • installation: pip install git+https://github.com/jldiaz/mkdocs-plugin-tags

mdoctag

This plugin just make a json file that contains meta data “tags”. To display aggregation of tag, you need to make pages referencing the json file.

  • author: srymh
  • links: Github | Docs | Demo
  • installation: pip install git+https://github.com/srymh/MkdocsTagPlugin

autotag

PyPI - Downloads

Automatically add tags to certain pages based on their path or filename. You will still need to use another tag plugin (such as mkdocs-material) for actually managing/displaying the tags.

Search (for mkdocs-material)

Material for MkDocs provides its own search plugin, which provides rich search previews (rendering text and code blocks in search), advanced separator support with lookahead and allows for the exclusion of whole pages, sections, and blocks.

Tags (for mkdocs-material)

Material for MkDocs adds first-class support for categorizing pages with tags, which adds the possibility to group related pages and make them discoverable via search and a dedicated tags index. If your documentation is large, tags can help to discover relevant information faster.