Blog

Mintlify Docs là gì và Cách sử dụng: Hướng dẫn cho người mới bắt đầu

Ashley Goolam

Ashley Goolam

4 tháng 6 2025

Mintlify Docs là gì và Cách sử dụng: Hướng dẫn cho người mới bắt đầu

Bạn có đang gặp khó khăn trong việc tạo tài liệu đẹp mắt, thân thiện với người dùng mà không cảm thấy nhàm chán? Hãy chào đón Mintlify, nền tảng gốc AI giúp xây dựng tài liệu ấn tượng dễ dàng như viết một bài blog. Với hơn 28 nghìn lượt sao trên GitHub và các khách hàng như Stripe, Mintlify cung cấp các tính năng tương tác, công cụ AI và tích hợp liền mạch để nâng tầm tài liệu của bạn. Trong hướng dẫn dành cho người mới bắt đầu này, tôi sẽ hướng dẫn bạn cài đặt Mintlify, thiết lập tên miền tùy chỉnh, tận dụng tính năng nạp dữ liệu AI, tích hợp máy chủ MCP, thêm bản dịch và sử dụng OpenAPI cho tài liệu API. Dù bạn là nhà phát triển hay trưởng nhóm, bạn sẽ tạo ra tài liệu chuyên nghiệp chỉ trong thời gian ngắn. Sẵn sàng biến việc làm tài liệu trở nên thú vị chưa? Hãy cùng bắt đầu!

💡
Trước khi bắt đầu, nếu bạn đang tìm cách tinh gọn quy trình phát triển API của mình, Apidog cung cấp một nền tảng tất cả trong một để thiết kế, kiểm thử và tạo tài liệu API. Với giao diện trực quan và các tính năng mạnh mẽ, nó hoàn hảo cho cả người mới bắt đầu và các nhà phát triển có kinh nghiệm. Tuyệt vời nhất là bạn có thể bắt đầu miễn phí! (apidog)
button

Mintlify là gì? Siêu năng lực tài liệu của bạn

Mintlify là một nền tảng tài liệu hiện đại giúp các nhà phát triển tạo ra tài liệu đẹp mắt, tương tác và thân thiện với SEO một cách dễ dàng. Được xây dựng cho các nhóm và dự án mã nguồn mở, nó hiển thị các tệp Markdown và MDX thành các trang phản hồi, hỗ trợ tích hợp GitHub và tích hợp các tính năng dựa trên AI như tạo mã và dịch thuật. Các lợi ích chính bao gồm:

Với quy trình kéo thả và tỷ lệ chuyển đổi người dùng cao hơn 40%, Mintlify hoàn hảo cho các công ty khởi nghiệp hoặc dự án công cộng. Hãy cùng thiết lập nó.

mintlify.com

Cài đặt và Thiết lập Mintlify

Bắt đầu với Mintlify rất dễ dàng, và bạn sẽ cần Node.js, CLI của Mintlify và tài khoản GitHub. Dưới đây là cách bắt đầu, dựa trên hướng dẫn chính thức.

1. Cài đặt các yêu cầu tiên quyết:

2. Sao chép Bộ khởi động:

git clone https://github.com/mintlify/starter-kit
cd starter-kit

3. Cài đặt Mintlify CLI:

npm install -g mintlify-cli

4. Chạy bản xem trước cục bộ:

mintlify-cli dev

5. Chỉnh sửa tài liệu của bạn:

{
  "name": "My Docs",
  "theme": "prism",
  "colors": { "primary": "#3498db" }
}

Tôi đã thiết lập điều này dưới 10 phút và có một trang web trực tiếp với các tùy chỉnh của mình—cực kỳ mượt mà!

Thiết lập Tên miền Tùy chỉnh cho Mintlify

Bạn muốn tài liệu của mình nằm tại docs.yourcompany.com thay vì tên miền phụ mintlify.app? Mintlify giúp việc thiết lập tên miền tùy chỉnh trở nên dễ dàng.

1. Truy cập Cài đặt:

custom domain

2. Thêm Tên miền của bạn:

cname

3. Chờ bản ghi được truyền bá:

Tôi đã thiết lập tên miền tùy chỉnh cho một trang web thử nghiệm, và nó đã hoạt động chỉ sau vài giờ—cảm giác chuyên nghiệp hoàn toàn!

Tận dụng tính năng Nạp dữ liệu AI với Mintlify

Tính năng nạp dữ liệu AI của Mintlify làm cho tài liệu của bạn thông minh hơn và dễ truy cập hơn, cho phép người dùng tìm kiếm nội dung thông qua các truy vấn được hỗ trợ bởi AI.

1. Bật tính năng Nạp dữ liệu AI:

ai chat

2. Kiểm tra Tìm kiếm AI:

3. Nâng cao bằng Sửa lỗi AI:

Tôi đã thử tìm kiếm AI trên một trang web mẫu, và nó tìm thấy tài liệu API của tôi ngay lập tức—nhanh hơn nhiều so với duyệt thủ công!

Tích hợp Máy chủ MCP với Mintlify

Giao thức ngữ cảnh mô hình (Model Context Protocol - MCP) cho phép các ứng dụng AI tương tác với tài liệu hoặc API của bạn. Mintlify tạo một máy chủ MCP để kết nối nội dung của bạn với LLMs.

1. Cài đặt MCP CLI:

npm i @mintlify/mcp

2. Cấu hình Máy chủ MCP:

3. Sử dụng Máy chủ MCP:

Cài đặt Máy chủ Mintlify MCP cục bộ

Để chạy máy chủ Mintlify MCP trên máy của bạn:

npx @mintlify/mcp add mintlify
install mintlify locally

Ví dụ: Tôi đã sử dụng Windsurf, và terminal cho tôi kết quả:

node C:\User\Me.mcp\mintlify\src\index.js
mcp command

Lời nhắc Mẫu (trong Windsurf):

Write a help doc about this feature based on this PRD, in the style and tone of AppleDB docs.

Hoặc, định dạng tương thích với Mintlify:

Write this in markdown using Mintlify components like anchors.
run in mcp client

Tôi đã thiết lập một máy chủ MCP, và nó cho phép trợ lý AI của tôi truy vấn tài liệu của tôi như một chuyên gia—thật là công nghệ tương lai!

Thêm Bản dịch vào Tài liệu Mintlify

Bạn muốn tài liệu của mình bằng nhiều ngôn ngữ? Tính năng dịch thuật được hỗ trợ bởi AI của Mintlify giúp việc bản địa hóa trở nên dễ dàng.

1. Bật tính năng Dịch thuật:

mintlify translation

2. Tùy chỉnh Bản dịch:

3. Kiểm tra Bản dịch:

switch between languages

Tôi đã thêm bản dịch tiếng Tây Ban Nha, và tài liệu của tôi đã sẵn sàng cho toàn cầu chỉ trong vài phút—một chiến thắng lớn về khả năng tiếp cận!

view all languages

Sử dụng Mintlify với VS Code

Tạo tài liệu cho mã trong VS Code? Tiện ích mở rộng của Mintlify giúp việc này trở nên dễ dàng!

1. Cài đặt Tiện ích mở rộng Mintlify:

vs code mintlify extension

2. Tạo Tài liệu:

Mã Mẫu:

test("@e2e wait for api response", async ({ page }) => {
  const sidemenuPage = new SideMenuPage(page);
  await sidemenuPage.interceptApiLink.click();
  const response = await page.waitForResponse((response) =>
    response.url().includes("/comments")
  );
  expect(response.status()).toBe(200);
  await page.getByText("CREATE post").isVisible();
});

Tài liệu được Tạo:

The code block is a test case that checks if the API response is received successfully.
use mintlify in vs code

Tôi đã tạo tài liệu cho một đoạn mã kiểm thử, và Mintlify đã mô tả chính xác—không cần nỗ lực!

Khám phá các Tính năng của Mintlify

Mintlify được tích hợp nhiều công cụ để làm cho tài liệu của bạn tỏa sáng. Dưới đây là cách nâng cấp:

Tôi đã điều chỉnh chủ đề và thêm tab, làm cho tài liệu của tôi trông như một thiết kế chuyên nghiệp chỉ trong vòng một giờ!

Kết thúc: Hành trình Mintlify của bạn bắt đầu

Tuyệt vời—bạn đã mở khóa sức mạnh của Mintlify để tạo ra tài liệu tuyệt đẹp, sẵn sàng cho AI! Từ việc cài đặt CLI đến thiết lập tên miền tùy chỉnh, nạp dữ liệu AI, máy chủ MCP, bản dịch và khu vực thử nghiệm OpenAPI, bạn đã sẵn sàng xây dựng tài liệu gây ấn tượng với người dùng. Hãy thử nghiệm các thành phần mới, thêm nhiều ngôn ngữ hơn hoặc tạo tài liệu cho API của bạn với APIdog! Chúc bạn tạo tài liệu vui vẻ!

button

Thực hành thiết kế API trong Apidog

Khám phá cách dễ dàng hơn để xây dựng và sử dụng API

Đăng ký miễn phíTải xuống