Cẩm nang NQDEV
HomeCheat SheetsContact
Công nghệ
Công nghệ
  • Introduction
  • Developer Roadmaps
    • Developer Roadmaps: Mô tả chi tiết
    • Roadmaps: ASP.NET Core Developer
    • Bảng phân loại cấp độ nhà phát triển .NET
    • ClearPath cho Team .NET Core
  • DotNET
    • ASP.NET Core
      • Hướng dẫn sử dụng tệp .http trong Visual Studio 2022 để thực hiện HTTP Requests
    • Message Queue
      • ZeroMQ
        • Xây dựng ZeroMQ Server trong dotNET 8 với CSharp
    • Playwright
      • Playwright: Tự Động Hóa Trình Duyệt Hiệu Quả
    • Optimize
      • Optimize - Một số cách tối ưu code và performance CSharp
    • Dev Blogs
      • Versions of .NET
        • Cập nhật từ .NET 9 lên .NET 10: Những thay đổi quan trọng
      • ASP.NET Core Web API với ASP.NET Core Web API (Native AOT): Bạn nên chọn loại nào?
      • Hướng dẫn xây dựng ứng dụng multi-tenant với .NET Core và MongoDB
      • Kiến Trúc Monolithic và Microservices: Lựa Chọn Phù Hợp Cho Dự Án Của Bạn
  • Design Patterns
    • CQRS Pattern
      • CQRS and MediatR trong .NET Core
    • Microservices
      • Ocelot
  • SQL Server
    • SQL Server Basics
    • SQL Server: DBCC
      • DBCC
      • DBCC SHOW_STATISTICS
      • DBCC SHRINKDATABASE
      • DBCC SHRINKFILE
      • DBCC SQLPERF
      • DBCC FREEPROCCACHE
    • SQL Server Replication
      • Giới thiệu SQL Server Replication
      • Hướng dẫn cấu hình và quản lý SQL Server Replication với Distribution Agent
    • SQL Server: Tập lệnh
      • SQL Server: Tập lệnh để tìm tất cả các giá trị Mặc định với Cột
    • Bảng tạm và sự linh hoạt trong xử lý dữ liệu lớn
    • Các bước để thay đổi nơi lưu trữ tệp log trong SQL Server
    • Các bước di chuyển tệp log trong SQL Server
    • Query Store trong SQL Server - Tổng Quan và Cách Quản Lý Hiệu Quả
    • SQL Server: Error Code
      • SQL Server Error : 14151, Severity: 18. Replication agent
  • Caching
    • Phân tích các phương pháp Caching dữ liệu trong .NET Core và .NET Framework
    • Redis
      • Redis mất dữ liệu khi restart
    • Varnish Cache
      • Hướng Dẫn Cài Đặt Varnish Cache với HAProxy Sử Dụng Docker Compose
  • NodeJS
    • NextJS
      • Hướng dẫn NextJS cho người mới bắt đầu
      • Parallel Routes trong Next.js
      • Hướng dẫn cấu hình Swagger trong NextJS
    • ReactJS
      • Hiểu về hook useRef của React như thế nào cho đúng
      • Tìm hiểu sâu hơn về useEffect từ A-Z
  • OS Linux
    • Tập lệnh Linux hay dùng
    • Centos 7
      • Hướng dẫn cài đặt và cấu hình Centos 7 dành cho người mới bắt đầu
      • Hướng Dẫn Kiểm Tra Các Cổng Đang Mở Trên Hệ Thống CentOS
      • Hướng Dẫn Sử Dụng zip Trên CentOS
      • Hướng dẫn cấu hình iptables để mở tất cả các cổng cho IP private
    • Windows
      • Hướng dẫn quản lý ứng dụng khởi động Windows bằng Registry Editor
  • VMware
    • Cách ảo hóa macOS Sierra trong VMWare Windows 10
    • Tự tin làm chủ mạng lưới: Cẩm nang tính toán địa chỉ IP từ A đến Z
  • Docker
    • Getting Started with Docker
    • Docker HUB
      • nqdev/nginx
  • Templates
    • Tabler Admin Template: Xây dựng Dashboard Quản trị đẹp mắt và dễ dàng
  • Open Source
    • shadcn-ui/ui
    • Kuma UI
    • Midone
  • Ứng dụng
    • Ansible
      • Ansible: Giới thiệu
      • Hướng dẫn chi tiết cài đặt Ansible
    • Apache JMeter
      • Features
        • Hướng dẫn chi tiết về Test Plan trong JMeter
        • Hướng dẫn chi tiết về Thread Group trong JMeter
    • DocFX
      • Những khái niệm cơ bản trong DocFX
      • DocFX - Hướng dẫn cài đặt, cấu hình sử dụng
      • DocFX - Hướng dẫn Markdown
      • DocFX - Hướng dẫn cấu hình file docfx.json
      • DocFX - Hướng dẫn sử dụng và tùy chỉnh Template
    • ETL Tools
      • Công cụ ETL Tools List & Software
      • Airbyte
        • Docker Compose
    • Elasticsearch
      • _reindex
        • Tìm hiểu sâu về API _reindex trong Elasticsearch
        • Hướng dẫn di chuyển dữ liệu trong Elasticsearch sử dụng API _reindex
      • _transform
    • HAProxy
      • HAProxy - Lập trình Lua và tích hợp Redis
    • Localtunnel
      • Hướng dẫn sử dụng Localtunnel để đưa ứng dụng Local lên Internet
    • LoopBack
      • Hướng dẫn cài đặt LoopBack 4 và khởi tạo dự án đầu tiên
    • N8N
      • Hướng dẫn cài đặt n8n bằng docker compose
    • NGINX Plus
      • NGINX: Hiệu suất vượt trội và giải pháp tối ưu cho hệ thống web
      • NGINX: Hướng dẫn chi tiết sử dụng GeoIP2 trên Alpine
      • NGINX: Hướng dẫn sử dụng Lua trên Alpine
      • NGINX: Hướng Dẫn Chi Tiết Cấu Hình Load Balancer
      • NGINX: Hướng Dẫn Sử Dụng Dynamic Modules
      • NGINX: Hướng dẫn Cài đặt và Sử dụng Module njs
      • Tích Hợp NGINX Làm API Gateway với Các Bước Xử Lý Phổ Biến
    • NTP - Secure Timeserver
      • Hướng dẫn cài đặt NTP an toàn với Docker Compose
    • Playwright
      • Playwright: Tự Động Hóa Trình Duyệt Hiệu Quả
    • Wordpress
      • Cách dùng Docker để phát triển ứng dụng Wordpress
  • Tin tức
    • DevSecOps là gì?
    • Giới thiệu bộ công cụ hỗ trợ lập trình từ SmallDev.tools và Code Beautify
    • Giới Thiệu và Hướng Dẫn Về DuckDB
    • Giới thiệu về Các Loại Cơ Sở Dữ Liệu
      • 1. HSQLDB (HyperSQL Database)
    • Hệ thống phân giải tên miền (DNS) và các loại bản ghi
    • Giải thích về Tiền Tố Path Nổi Tiếng – /.well-known
    • Giải mã Hệ thống tạo mã OTP của Google Authenticator
    • Quishing là gì? Hiểu và phòng tránh lừa đảo qua mã QR
  • Hướng dẫn
    • Hướng dẫn chi tiết tạo tài khoản Google bằng email công ty
    • Top 10 ASP .NET Open Source Projects GitHub 2024
    • Free Themes and Templates from Creative Tim
    • Hướng dẫn sử dụng Voler và Mazer Dashboard từ Zuramai
  • So Sánh
    • So Sánh Apache Parquet và CSV: Bảng So Sánh Chi Tiết, Ưu và Nhược Điểm
    • So Sánh Varnish Cache, Memcached và Redis: Ba Công Cụ Caching Phổ Biến trong Tối Ưu Hóa Hiệu Suất
  • Affiliate
    • Tuyển dụng
      • Bộ câu hỏi phỏng vấn T-SQL – Đánh giá ứng viên hiệu quả
    • eSMSvn: Chăm sóc khách hàng hiệu quả với SMS và ZNS
    • eSMS.vn: Giải pháp SMS Marketing hiệu quả cùng các chương trình ưu đãi hấp dẫn
Powered by GitBook
On this page
  • Tóm tắt
  • 1. Tài liệu tĩnh (Static Content)
  • Cách sử dụng:
  • Lợi ích:
  • 2. Tài liệu API (API Documentation)
  • Quy trình tạo tài liệu API:
  • Lợi ích:
  • 3. File cấu hình (docfx.json)
  • Ví dụ file docfx.json:
  • Các phần quan trọng:
  • 4. Giao diện (Templates)
  • Tùy chỉnh template:
  • 5. Quy trình build
  • Cách thực hiện:
  • 6. Phục vụ tài liệu (Serve Documentation)
  • 7. Tích hợp CI/CD

Was this helpful?

  1. Ứng dụng
  2. DocFX

Những khái niệm cơ bản trong DocFX

DocFX là công cụ mạnh mẽ để tạo tài liệu tĩnh (static documentation) và tài liệu API tự động.

Hiểu rõ các khái niệm cơ bản của DocFX sẽ giúp bạn sử dụng nó một cách hiệu quả hơn trong các dự án của mình. Bài viết này sẽ giải thích các thành phần quan trọng của DocFX và cách chúng phối hợp với nhau.

Tóm tắt

DocFX là công cụ mạnh mẽ giúp bạn tạo tài liệu cho các dự án .NET với nhiều tính năng vượt trội:

  • Hỗ trợ Markdown để viết tài liệu tĩnh.

  • Tự động tạo tài liệu API từ code.

  • Dễ dàng tùy chỉnh giao diện và tích hợp vào CI/CD.


1. Tài liệu tĩnh (Static Content)

DocFX cho phép bạn sử dụng các file Markdown (*.md) để tạo nội dung tài liệu. Đây là các file bạn viết thủ công và chứa nội dung như hướng dẫn sử dụng, ghi chú kỹ thuật hoặc bất kỳ tài liệu nào bạn muốn hiển thị trên website.

Cách sử dụng:

  • Đặt các file Markdown trong thư mục nội dung, ví dụ: articles/ hoặc docs/.

  • DocFX sẽ chuyển đổi chúng thành các trang HTML tĩnh trong quá trình build.

Lợi ích:

  • Markdown dễ viết, dễ đọc, và hỗ trợ nhiều cú pháp linh hoạt.

  • Có thể nhúng hình ảnh, mã code, và liên kết nội bộ.


2. Tài liệu API (API Documentation)

Tính năng nổi bật của DocFX là khả năng tự động tạo tài liệu API từ code hoặc file XML comments. Điều này đặc biệt hữu ích khi làm việc với các dự án .NET.

Quy trình tạo tài liệu API:

  1. Tạo metadata: DocFX đọc file *.csproj hoặc *.dll trong dự án của bạn để tạo metadata cho API.

  2. Sinh tài liệu: Từ metadata, DocFX tạo ra các trang mô tả từng class, method, property, và event trong API.

Lợi ích:

  • Tự động hóa tài liệu API, giúp tiết kiệm thời gian.

  • Tài liệu luôn đồng bộ với mã nguồn.

  • Dễ dàng tích hợp vào quy trình CI/CD.


3. File cấu hình (docfx.json)

File docfx.json là trung tâm quản lý cấu hình của DocFX. Nó định nghĩa các thông tin như:

  • Vị trí lưu file Markdown và tài liệu API.

  • Cài đặt cho quá trình build và phục vụ.

  • Các tùy chỉnh giao diện và template.

Ví dụ file docfx.json:

docfx.json
{
    "metadata": [
        {
            "src": [
                {
                    "files": [ "**/*.csproj" ],
                    "cwd": "src"
                }
            ]
        }
    ],
    "build": {
        "content": [
            {
                "files": [ "**/*.md" ]
            }
        ],
        "dest": "_site"
    }
}

Các phần quan trọng:

  • metadata: Chỉ định nơi DocFX sẽ tìm kiếm các file mã nguồn để tạo tài liệu API.

  • build: Định nghĩa nơi lưu nội dung và thư mục đầu ra.


4. Giao diện (Templates)

DocFX hỗ trợ các template để tùy chỉnh giao diện của trang tài liệu. Bạn có thể:

  • Sử dụng template mặc định.

  • Tạo template tùy chỉnh theo nhu cầu.

  • Sử dụng các extension để mở rộng chức năng.

Tùy chỉnh template:

  • Templates được lưu trong thư mục templates/.

  • Có thể sửa đổi CSS, HTML để thay đổi giao diện hoặc thêm các tính năng mới.


5. Quy trình build

Quá trình build của DocFX bao gồm 3 bước chính:

  1. Tạo metadata:

    • Đọc file cấu hình docfx.json để tạo thông tin về tài liệu API.

  2. Chuyển đổi nội dung:

    • Biến các file Markdown thành HTML.

    • Kết hợp metadata để tạo tài liệu API.

  3. Xuất kết quả:

    • Tạo các file HTML tĩnh trong thư mục đầu ra (thường là _site).

Cách thực hiện:

  • Sử dụng lệnh docfx build để thực hiện quá trình này.

  • Kết quả có thể được phục vụ thông qua một server hoặc đẩy lên các dịch vụ như GitHub Pages.


6. Phục vụ tài liệu (Serve Documentation)

Sau khi build, bạn có thể kiểm tra tài liệu của mình bằng cách chạy server nội bộ:

docfx serve _site
  • Server chạy ở http://localhost:8080 (có thể tùy chỉnh cổng).

  • Thích hợp cho việc kiểm tra trước khi triển khai chính thức.


7. Tích hợp CI/CD

DocFX dễ dàng tích hợp vào các pipeline CI/CD để tự động build và triển khai tài liệu. Ví dụ:

  • GitHub Actions: Thiết lập workflow để build và đẩy tài liệu lên GitHub Pages.

  • Azure DevOps: Tích hợp vào pipeline để triển khai tự động.


Với sự hỗ trợ đa nền tảng và khả năng mở rộng, DocFX là lựa chọn lý tưởng cho các dự án cần tài liệu chuyên nghiệp. Hãy bắt đầu với DocFX ngay hôm nay và biến tài liệu của bạn trở nên dễ dàng hơn bao giờ hết!

Nếu có thắc mắc, hãy để lại bình luận để trao đổi thêm nhé! 😊

PreviousDocFXNextDocFX - Hướng dẫn cài đặt, cấu hình sử dụng

Last updated 5 months ago

Was this helpful?