# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: MkDocs Material spec: description: | MkDocs Material is a documentation framework built on MkDocs with the Material for MkDocs theme. Write docs in Markdown, get a beautiful, responsive, searchable static site with built-in dark mode, navigation tabs, and code highlighting. coverImage: https://avatars.githubusercontent.com/u/76895193 icon: https://avatars.githubusercontent.com/u/76895193 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access MkDocs Material tags: - Tool - Documentation readme: | # MkDocs Material A documentation framework powered by MkDocs with the Material theme. Write your docs in Markdown and get a polished, searchable static site out of the box. ## What You Can Do After Deployment 1. **Visit your domain** — a sample MkDocs site is served immediately 2. **Mount your docs** — add your Markdown files and `mkdocs.yml` config via a volume or custom image 3. **Live preview** — the built-in dev server reloads on file changes 4. **Search works instantly** — client-side search is included with no extra setup ## Key Features - **Material Design** — clean, responsive layout with dark/light mode toggle - **Navigation** — tabs, sections, table of contents, back-to-top button - **Search** — instant client-side search with highlighting - **Code Blocks** — syntax highlighting for 300+ languages, copy button, annotations - **Admonitions** — note, warning, tip, danger callout boxes - **Diagrams** — Mermaid.js integration for flowcharts and sequence diagrams - **Versioning** — mike integration for multi-version docs - **Blog** — built-in blog plugin for changelogs and announcements ## License MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) services: - name: mkdocs-material icon: https://avatars.githubusercontent.com/u/76895193 template: PREBUILT_V2 spec: source: image: squidfunk/mkdocs-material:9.7.6 ports: - id: web port: 8000 type: HTTP healthCheck: type: HTTP port: web http: path: / domainKey: PUBLIC_DOMAIN localization: es-ES: description: | MkDocs Material es un framework de documentación basado en MkDocs con el tema Material. Escribe en Markdown y obtén un sitio estático buscable con modo oscuro, navegación por pestañas y resaltado de código. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a MkDocs Material readme: | # MkDocs Material Framework de documentación con MkDocs y tema Material. Escribe en Markdown, obtén un sitio buscable y elegante. ## Qué puedes hacer después del despliegue 1. **Visita tu dominio** — sitio de ejemplo listo al instante 2. **Monta tus docs** — agrega Markdown y mkdocs.yml 3. **Vista previa en vivo** — recarga automática al cambiar archivos 4. **Búsqueda lista** — búsqueda del lado del cliente incluida ## Características principales - Diseño Material responsivo con modo claro/oscuro - Pestañas de navegación, tabla de contenidos - Búsqueda instantánea con resaltado - Resaltado de sintaxis para 300+ lenguajes - Cajas de advertencia (note, warning, tip) - Diagramas Mermaid.js ## Licencia MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) id-ID: description: | MkDocs Material adalah framework dokumentasi berbasis MkDocs dengan tema Material. Tulis dalam Markdown, dapatkan situs statis yang indah dan dapat dicari dengan mode gelap, navigasi tab, dan penyorotan kode. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses MkDocs Material readme: | # MkDocs Material Framework dokumentasi dengan MkDocs dan tema Material. Tulis dalam Markdown, dapatkan situs statis yang elegan dan dapat dicari. ## Apa yang bisa dilakukan setelah deploy 1. **Buka domain** — situs contoh langsung tersedia 2. **Mount dokumen** — tambahkan Markdown dan mkdocs.yml 3. **Preview langsung** — reload otomatis saat file berubah 4. **Pencarian siap pakai** — pencarian sisi klien sudah termasuk ## Fitur utama - Desain Material responsif dengan mode gelap/terang - Tab navigasi, daftar isi - Pencarian instan dengan penyorotan - Penyorotan sintaks 300+ bahasa - Kotak peringatan (note, warning, tip) - Diagram Mermaid.js ## Lisensi MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) ja-JP: description: | MkDocs Materialは、MkDocsとMaterialテーマによるドキュメントフレームワーク。Markdownで書くだけで、美しく検索可能なサイトが完成します。ダークモード、ナビゲーション、コードハイライト内蔵。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: MkDocs Materialにアクセスするドメイン readme: | # MkDocs Material MkDocsとMaterialテーマによるドキュメントフレームワーク。Markdownで書いて、美しい検索可能なサイトを構築。 ## デプロイ後にできること 1. **ドメインにアクセス** — サンプルサイトがすぐに表示 2. **ドキュメントをマウント** — MarkdownとmkDocsの設定を追加 3. **ライブプレビュー** — ファイル変更時に自動リロード 4. **検索がすぐに動作** — クライアント側検索を内蔵 ## 主な機能 - Material Designレスポンシブレイアウト - ナビゲーションタブ、目次 - インスタント検索とハイライト - 300以上の言語のシンタックスハイライト - 注意書きボックス（note、warning、tip） - Mermaid.jsフローチャート ## ライセンス MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) ko-KR: description: | MkDocs Material은 MkDocs와 Material 테마 기반의 문서 프레임워크입니다. Markdown으로 작성하면 검색 가능한 정적 사이트가 완성됩니다. 다크 모드, 네비게이션, 코드 하이라이트 내장. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: MkDocs Material에 접속할 도메인 readme: | # MkDocs Material MkDocs와 Material 테마 기반 문서 프레임워크. Markdown으로 작성하면 아름답고 검색 가능한 사이트 완성. ## 배포 후 할 수 있는 것 1. **도메인 접속** — 샘플 사이트 즉시 표시 2. **문서 마운트** — Markdown과 mkdocs.yml 추가 3. **실시간 미리보기** — 파일 변경 시 자동 리로드 4. **검색 바로 사용** — 클라이언트 측 검색 내장 ## 주요 기능 - Material Design 반응형 레이아웃 - 네비게이션 탭, 목차 - 즉석 검색 및 하이라이트 - 300+ 언어 구문 강조 - 알림 박스 (note, warning, tip) - Mermaid.js 플로차트 ## 라이선스 MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) th-TH: description: | MkDocs Material คือเฟรมเวิร์กเอกสารบน MkDocs พร้อมธีม Material เขียนด้วย Markdown ได้เว็บไซต์สวยงาม ค้นหาได้ พร้อมโหมดมืด แท็บนำทาง และไฮไลท์โค้ด variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง MkDocs Material readme: | # MkDocs Material เฟรมเวิร์กเอกสารบน MkDocs พร้อมธีม Material เขียนด้วย Markdown ได้เว็บไซต์สวยงามและค้นหาได้ทันที ## สิ่งที่ทำได้หลังจากติดตั้ง 1. **เข้าสู่โดเมน** — เว็บตัวอย่างพร้อมใช้งาน 2. **เมาท์เอกสาร** — เพิ่ม Markdown และ mkdocs.yml 3. **ดูตัวอย่างสด** — รีโหลดอัตโนมัติเมื่อไฟล์เปลี่ยน 4. **ค้นหาพร้อมใช้** — การค้นหาฝั่งไคลเอนต์รวมอยู่แล้ว ## ฟีเจอร์หลัก - ดีไซน์ Material ตอบสนอง โหมดมืด/สว่าง - แท็บนำทาง สารบัญ - ค้นหาทันทีพร้อมไฮไลท์ - ไฮไลท์ซินแท็กซ์ 300+ ภาษา - กล่องแจ้งเตือน (note, warning, tip) - แผนภาพ Mermaid.js ## สัญญาอนุญาต MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) zh-CN: description: | MkDocs Material 是基于 MkDocs 搭配 Material 主题的文档框架。用 Markdown 编写文档，即可生成美观、响应式、可搜索的静态站点，内置深色模式、导航标签与代码高亮。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 MkDocs Material 的域名 readme: | # MkDocs Material 基于 MkDocs 搭配 Material 主题的文档框架。用 Markdown 写文档，即刻获得精美可搜索的静态站点。 ## 部署后可以做什么 1. **打开域名** — 示例文档站点即刻可用 2. **挂载文档** — 通过 Volume 或自定义镜像添加 Markdown 与 mkdocs.yml 3. **实时预览** — 内置开发服务器自动重载 4. **搜索开箱即用** — 前端搜索无需额外配置 ## 主要功能 - Material Design 响应式布局，深色/浅色切换 - 导航标签、目录、返回顶部 - 即时前端搜索与高亮 - 300+ 语言语法高亮 - 告警框（note、warning、tip、danger） - Mermaid.js 流程图 ## 授权 MIT — [GitHub](https://github.com/squidfunk/mkdocs-material) zh-TW: description: | MkDocs Material 是基於 MkDocs 搭配 Material 主題的文件框架。用 Markdown 撰寫文件，即可產生美觀、響應式、可搜尋的靜態網站，內建深色模式、導覽分頁與程式碼高亮。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 MkDocs Material 的網域 readme: | # MkDocs Material 基於 MkDocs 搭配 Material 主題的文件框架。用 Markdown 寫文件，立即獲得精美且可搜尋的靜態網站。 ## 部署後可以做什麼 1. **開啟網域** — 範例文件網站立即可用 2. **掛載文件** — 透過 Volume 或自訂映像檔加入 Markdown 與 mkdocs.yml 3. **即時預覽** — 內建開發伺服器在檔案變更時自動重載 4. **搜尋直接可用** — 前端搜尋無需額外設定 ## 主要功能 - Material Design 響應式佈局，深色/淺色切換 - 導覽分頁、目錄、回到頂端按鈕 - 即時前端搜尋與關鍵字高亮 - 300+ 語言語法高亮、複製按鈕、程式碼註解 - 警告框（note、warning、tip、danger） - Mermaid.js 流程圖與序列圖 - mike 多版本文件管理 - 內建部落格外掛 ## 授權 MIT — [GitHub](https://github.com/squidfunk/mkdocs-material)