Tóm tắt nhanh / Lệnh

Bộ Engineer

/ak:mintlify

Site docs Mintlify

Xây và bảo trì site docs Mintlify qua docs.json, component MDX, navigation, frontmatter, theme, docs API, asset AI, deploy và kiểm tra cục bộ bằng Mintlify CLI.

01

Khoanh vùng việc Mintlify

02

Kiểm tra docs.json

03

Lập navigation và nội dung

04

Viết trang MDX

Nguyên tắc 01

docs.json định nghĩa theme, navigation, branding, màu và integration

Nguyên tắc 02

Trang MDX nên dùng frontmatter và component tích hợp của Mintlify

Nguyên tắc 03

Docs API có thể sinh từ spec OpenAPI hoặc AsyncAPI với playground và ví dụ

Nguyên tắc 04

Asset docs cho AI như llms.txt và skill.md là deliverable Mintlify quan trọng

Bản đồ thực thi

Các nhánh chính từ đầu vào đến kết quả, bám theo cách command chạy khi dùng thật.

01

Khởi động

Đầu vào, phạm vi, route

  1. 1 Khoanh vùng việc Mintlify Xác nhận yêu cầu nhắm vào cấu trúc site, nội dung MDX, cấu hình docs.json, navigation, docs API, asset AI, deploy hay kiểm tra cục bộ.
  2. 2 Kiểm tra docs.json Rà theme, branding, màu, integration, nhóm navigation, tab, anchor, product, version, ngôn ngữ và frontmatter trang hiện có.
02

Xử lý

Agent / skill thực thi

  1. 3 Lập navigation và nội dung Chọn theme, locale, pattern navigation, page mode, redirect và cách dùng component Mintlify được hỗ trợ, khớp với site docs hiện có.
  2. 4 Viết trang MDX Viết frontmatter và MDX với component riêng của Mintlify như Note, CodeGroup, Steps, component API, callout, sơ đồ và khối tương tác.
03

Kiểm chứng

Gate, review, xác thực

  1. 5 Kết nối docs API và AI Thêm tài liệu OpenAPI hoặc AsyncAPI, playground, ví dụ đa ngôn ngữ, llms.txt, skill.md, hỗ trợ MCP và tuỳ chọn menu AI theo ngữ cảnh khi cần.
  2. 6 Chạy kiểm tra cục bộ Dùng lệnh Mintlify CLI phù hợp: mint dev để preview, mint validate cho docs.json, mint broken-links, mint a11y và mint openapi-check.
04

Đóng

Báo cáo, bàn giao, artifact

  1. 7 Chuẩn bị deploy Căn site theo auto-deploy GitHub hoặc GitLab, preview deploy, custom domain, subpath hosting hoặc target Vercel, Cloudflare và AWS.

Cú pháp, đối số, subcommand

Cách gọi skill: cú pháp, đối số vị trí, option dùng chung, rồi từng subcommand với cú pháp và kết quả riêng.

Cú pháp

/ak:mintlify [task] [path]

Đối số

[task] Bắt buộc

Việc docs

Outcome, ràng buộc, file được phép đổi, lệnh validate và điểm dừng bằng ngôn ngữ tự nhiên. Nội dung này không tự cấp quyền thao tác hosted account, dashboard, DNS, Git, publish preview hoặc deploy.

/ak:mintlify "Trong ./docs-site, add một group Authentication, chạy mint validate và mint broken-links, và stop trước deployment."
[path]

Thư mục docs

Đường dẫn tùy chọn tới project Mintlify hoặc thư mục docs. Nên ghi khi target không rõ từ workspace hiện tại.

/ak:mintlify "Update điều hướng API" ./docs-site

Prompt mẫu

Ví dụ gọi command theo từng flag, subcommand, mode hoặc route dùng được trong workflow thực tế.

Cấu trúc docs Khuyến nghị
/ak:mintlify tổ chức lại điều hướng docs API
Dùng khi:
Dùng khi cấu trúc site docs Mintlify, navigation hoặc nhóm trang cần chỉnh.
Kết quả:
Sắp xếp lại navigation docs.json bằng group, tab, anchor, product, version hoặc pattern ngôn ngữ được hỗ trợ, đồng thời giữ frontmatter trang.
Trang MDX
/ak:mintlify thêm trang quickstart với Steps và CodeGroup
Dùng khi:
Dùng khi thêm hoặc cải thiện trang nội dung MDX của Mintlify.
Kết quả:
Tạo hoặc cập nhật trang MDX với frontmatter đúng và component Mintlify như Steps, CodeGroup, Note, callout hoặc sơ đồ.
Docs API
/ak:mintlify kết nối OpenAPI spec với trang docs
Dùng khi:
Dùng khi cần tài liệu API tương tác trong Mintlify.
Kết quả:
Kết nối spec OpenAPI hoặc AsyncAPI vào tài liệu API Mintlify, gồm hành vi playground, ví dụ đa ngôn ngữ và validate bằng openapi-check.
Kiểm tra cục bộ
/ak:mintlify chạy validation cục bộ cho docs.json và các liên kết
Dùng khi:
Dùng khi site docs Mintlify cần preview, kiểm tra cấu hình, link, accessibility hoặc spec API trước khi giao.
Kết quả:
Chạy luồng Mintlify CLI phù hợp như mint dev, mint validate, mint broken-links, mint a11y hoặc mint openapi-check và báo phần cần sửa.

Phạm vi xử lý

  • Cấu hình docs.json
  • Frontmatter MDX và component Mintlify
  • Kiến trúc navigation và localization
  • Tài liệu OpenAPI và AsyncAPI
  • Asset docs AI: llms.txt, skill.md và hỗ trợ MCP
  • Preview và validate bằng Mintlify CLI

Artifact tạo ra

Output site docs Mintlify

Mẫu đường dẫn

docs.json + trang MDX + asset docs API hoặc AI + kiểm tra mint CLI phù hợp

Việc Mintlify nên giữ cấu trúc site, dùng cấu hình và component được hỗ trợ, rồi chạy kiểm tra cục bộ phù hợp với bề mặt đã đổi.

Tiếp theo