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
  • Giới thiệu
  • 1. Markdown cơ bản
  • 2. Mở rộng Markdown trong DocFX
  • 2.1. Tab Group
  • 2.2. Note (Chú thích)
  • 2.3. Liên kết chéo
  • 2.4. Chèn hình ảnh và video
  • 2.5. Bảng (Table)
  • 3. Tùy chỉnh Markdown trong DocFX
  • 3.1. Sử dụng YAML Metadata
  • 3.2. Cấu hình Markdown trong docfx.json
  • 4. Kết hợp Markdown với tài liệu API
  • 5. Tài nguyên hỗ trợ
  • Kết luận

Was this helpful?

  1. Ứng dụng
  2. DocFX

DocFX - Hướng dẫn Markdown

Markdown là một ngôn ngữ đánh dấu đơn giản, được sử dụng rộng rãi để tạo tài liệu văn bản dễ đọc và dễ viết.

PreviousDocFX - Hướng dẫn cài đặt, cấu hình sử dụngNextDocFX - Hướng dẫn cấu hình file docfx.json

Last updated 5 months ago

Was this helpful?

Giới thiệu

Trong , Markdown là thành phần cốt lõi, giúp bạn viết nội dung tài liệu nhanh chóng với các tính năng mở rộng mạnh mẽ. Bài viết này sẽ hướng dẫn bạn cách sử dụng Markdown trong DocFX, bao gồm các cú pháp cơ bản, các mở rộng hỗ trợ và cách tùy chỉnh.


1. Markdown cơ bản

Các cú pháp Markdown phổ biến:

  1. Tiêu đề:

    # Tiêu đề 1
    ## Tiêu đề 2
    ### Tiêu đề 3

    Kết quả:

    Tiêu đề 1
    Tiêu đề 2
    Tiêu đề 3

  2. In đậm và in nghiêng:

    **In đậm**
    *In nghiêng*

    Kết quả: In đậm và In nghiêng.

  3. Danh sách:

    • Danh sách không thứ tự:

      - Mục 1
      - Mục 2

    • Danh sách có thứ tự:

      1. Mục 1
      2. Mục 2

  4. Liên kết và hình ảnh:

    [Liên kết](https://example.com)
    ![Hình ảnh](https://example.com/image.png)

  5. Khối mã:

    ```language
    Code block


2. Mở rộng Markdown trong DocFX

DocFX hỗ trợ các mở rộng Markdown để cung cấp thêm nhiều tính năng.

2.1. Tab Group

Sử dụng tab để hiển thị nội dung theo các tùy chọn khác nhau:

# [Tab 1 Title](#tab/tab1)
Nội dung Tab 1

# [Tab 2 Title](#tab/tab2)
Nội dung Tab 2

# [Tab End](#tab/end)

2.2. Note (Chú thích)

Hiển thị các ghi chú dạng cảnh báo, thông báo hoặc mẹo:

> [!NOTE]
> Đây là ghi chú thông thường.

> [!WARNING]
> Đây là cảnh báo.

> [!TIP]
> Đây là một mẹo hay.

2.3. Liên kết chéo

Dẫn liên kết giữa các trang hoặc tài liệu:

[Liên kết đến trang khác](xref:uid_of_the_target)

2.4. Chèn hình ảnh và video

Hỗ trợ nhúng hình ảnh:

![Mô tả hình ảnh](image_url)

Và video:

::: video
source: video_url
:::

2.5. Bảng (Table)

Tạo bảng với Markdown:

| Cột 1 | Cột 2 | Cột 3 |
|-------|-------|-------|
| Dữ liệu 1 | Dữ liệu 2 | Dữ liệu 3 |

3. Tùy chỉnh Markdown trong DocFX

3.1. Sử dụng YAML Metadata

YAML Metadata cho phép bạn thêm thông tin meta vào đầu file Markdown:

---
uid: unique_identifier
title: Tiêu đề trang
description: Mô tả ngắn gọn
---

3.2. Cấu hình Markdown trong docfx.json

Bạn có thể cấu hình Markdown trong DocFX bằng cách thêm phần markdownEngine vào file docfx.json:

{
  "build": {
    "markdownEngineName": "dfm",
    "markdownEngineProperties": {
      "enableContentPlaceholder": true,
      "enableFileLinkPlaceholder": true
    }
  }
}

4. Kết hợp Markdown với tài liệu API

Markdown trong DocFX không chỉ dùng cho nội dung tùy chỉnh mà còn có thể được tích hợp với tài liệu API để thêm giải thích hoặc ví dụ. Điều này giúp cải thiện chất lượng tài liệu và trải nghiệm người dùng.

Ví dụ, bạn có thể thêm các phần mở rộng Markdown vào tài liệu API:

### [!NOTE]
Đây là tài liệu API được mở rộng với Markdown.

5. Tài nguyên hỗ trợ

Để hiểu rõ hơn về Markdown trong DocFX, bạn có thể tham khảo thêm:

- [Tài liệu Markdown chính thức của DocFX](https://dotnet.github.io/docfx/docs/markdown.html)
- [Hướng dẫn Markdown cơ bản](https://www.markdownguide.org/)


Kết luận

Markdown là công cụ đơn giản nhưng mạnh mẽ trong DocFX, giúp bạn tạo tài liệu chất lượng cao một cách nhanh chóng. Với các mở rộng và tùy chỉnh của DocFX, bạn có thể tận dụng Markdown để tăng tính chuyên nghiệp và dễ đọc của tài liệu.

Hãy thử sử dụng Markdown trong DocFX ngay hôm nay và chia sẻ trải nghiệm của bạn! 😊


Nếu bạn có câu hỏi hoặc cần hỗ trợ thêm, hãy để lại bình luận dưới bài viết nhé!

DocFX