Communitygithub.com

使用 Material for MkDocs 建立具搜尋與導覽的版本化技術文件網站

使用 Material for MkDocs 將 Markdown 文件轉換為一個可搜尋、便於導覽的靜態網站,並提供專案可用的配置與預覽功能。

使用 Material for MkDocs 建立具搜尋與導覽的版本化技術文件網站 是什麼?

此技能可協助你運用 Material for MkDocs,快速將 Markdown 文件建置成具備版本控制、全文搜尋與直覺導覽的技術文件靜態網站。它能自動產生專案層級的配置(如 mkdocs.yml)並提供即時預覽,大幅減少手動設定時間。支援的平台包括任何能執行 Python、pip 或 Docker 的環境(如本地開發機、CI/CD 管線),也能與 Claude Code、Cursor 等 AI 代理工具整合。運作方式為:先確認 Python、pip 或 Docker 已安裝,再透過 pip install mkdocs-material 安裝主題,並在 mkdocs.yml 中啟用必要外掛(如版本化切換或搜尋外掛),最後執行 mkdocs serve 啟動開發伺服器進行預覽。此技能特別適合需要維護多版本文件(例如 API 文件、SDK 文件)的開發團隊,可讓使用者直接在同一站點中切換不同版本的文件內容。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/agentskillexchange/skills/tree/main/skills/build-versioned-technical-docs-sites-with-search-and-nav-using-material-for-mkdocs

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

使用 Material for MkDocs 建立具搜尋與導覽的版本化技術文件網站 是做什麼的?

使用 Material for MkDocs 將 Markdown 文件轉換為一個可搜尋、便於導覽的靜態網站,並提供專案可用的配置與預覽功能。

前置需求

Python、pip 或 Docker、MkDocs、Material for MkDocs、Markdown 文件檔案

安裝

請根據您的環境選擇上游提供的安裝或設定方式:

  • 自訂您的站點 – 變更顏色、字型、語言、圖示、標誌等更多選項
  • pip install mkdocs-material

上游的需求與注意事項:

基本使用或入門說明:

文件

來源

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

Academic Paper Citation Network Mapper

Builds citation networks from Semantic Scholar API and CrossRef DOI metadata. Visualizes paper influence graphs using NetworkX, identifies seminal works, and tracks research lineage across fields.

ACF Custom Fields REST Exposer

Exposes Advanced Custom Fields data through the WordPress REST API using register_rest_field and acf_format_value. Handles repeater fields, flexible content layouts, and gallery fields with proper serialization.

ACF Extended for Advanced Custom Fields Workflows

An ASE skill built around ACF Extended, the WordPress enhancement suite for Advanced Custom Fields that adds field types, admin improvements, front-end forms, options pages, and developer tooling. It is a practical fit for agents working inside complex WordPress content models and custom field workflows.

ACF to Gutenberg Block Migrator

Converts Advanced Custom Fields field groups into native Gutenberg blocks using the ACF Block API v2 and @wordpress/scripts build pipeline. Maps ACF repeaters, groups, and flexible content to InnerBlocks and block attributes with server-side rendering via acf_register_block_type().

Activepieces Open Source Workflow Automation

Activepieces is an open-source, self-hostable workflow automation platform with 200+ integrations. It provides a visual builder for creating automated workflows and exposes all its connectors as MCP servers for AI agent use.

ActivityWatch Cross-Platform Automated Time Tracker and Producti

ActivityWatch is a privacy-first, open-source automated time tracker that records application usage, browser activity, and AFK status across Windows, macOS, and Linux. With 16k+ GitHub stars, it provides detailed productivity analytics without sending data to external servers.

act Local GitHub Actions Runner

act is an open-source CLI tool that runs GitHub Actions workflows locally using Docker, enabling fast feedback on workflow changes without pushing to GitHub. It is a standard tool for local Actions development and testing.

Add a browser review checkpoint before risky agent actions with

Use AgentClick when an agent should pause before risky commands, plans, drafts, or code changes so a human can inspect, edit, approve, or reject them in a purpose-built browser UI.

Add Claude design-system and accessibility workflows with UX/UI

Use UX/UI Agent Skills when Claude should generate tokens, component specs, accessibility audits, and framework-specific UI code from a repeatable design workflow.

Add executable smoke tests for shell scripts and CLIs before ref

Use Bats-core when an agent needs to turn fragile shell scripts or command-line workflows into something it can verify repeatedly after edits. The agent writes focused Bash tests for success paths, failure paths, and output contracts, then runs them locally or in CI before a refactor, release, or incident fix goes out.

Add graph-backed memory and context retrieval to agent workflows

Use Cognee to ingest project knowledge into graph and vector memory so agents can retrieve durable context across sessions and workflows.

Add IDE-style semantic code navigation and symbol-safe refactors

Give a coding agent symbol-aware lookup, cross-file rename, and structural edit tools before it starts making brittle text-only changes.

Add managed long-term memory to LangGraph agents with LangMem

Give LangGraph agents memory management and search tools so they can store, retrieve, and update durable facts across sessions.

Add multimodal lifelong memory to MCP and Python agents with Sim

Use SimpleMem to store, compress, index, and retrieve text or multimodal memories for agents through MCP or Python integrations.

Add persistent project memory and hook-driven synthesis with Cla

Keep Claude Code sessions grounded in prior decisions, project context, and daily handoff notes instead of starting from zero every time.

Add Postgres-native vector retrieval to agent and RAG workflows

Store embeddings beside application data in Postgres, create vector indexes, and query nearest neighbors for semantic search, RAG, recommendations, or agent memory retrieval.

Address GitHub PR review comments from the current branch with g

Find the open PR for the current branch, gather unresolved review comments, and drive a focused comment-resolution workflow with gh-authenticated context.

Add runtime guardrails to TypeScript agents with VoltAgent

Use VoltAgent to intercept, validate, and enforce input/output policies in TypeScript agent workflows.

Add temporal context memory to agent workflows with Zep

Use Zep as an external context layer for agents that need to store events, assemble temporal graph context, and retrieve relevant memory before model calls.

Adobe Firefly API Batch Image Generator

Calls Adobe Firefly

相關技能