Đặt câu hỏi và nhận tóm tắt tài liệu bằng cách tham chiếu trang này và nhà cung cấp AI bạn chọn
Lịch sử phiên bản
- "Cho phép phân tích cú pháp trước AST Markdown cho SSR / hydrat hóa"v8.11.028/5/2026
- "Thêm hỗ trợ cho các tệp `.content.md`"v8.10.019/5/2026
- "Thêm đối tượng plugin `intlayerMarkdown`; sử dụng `app.use(intlayerMarkdown)` thay vì `app.use(installIntlayerMarkdown)`"v8.5.024/3/2026
- "Di chuyển import từ `{{framework}}-intlayer` sang `{{framework}}-intlayer/markdown`"v8.5.024/3/2026
- "Thêm tiện ích MarkdownRenderer / useMarkdownRenderer / renderMarkdown và tùy chọn forceInline"v8.0.022/1/2026
- "Trang trí tự động nội dung markdown, hỗ trợ MDX và SSR"v8.0.018/1/2026
- "Khởi tạo lịch sử"v5.5.1029/6/2025
Nội dung của trang này đã được dịch bằng AI.
Xem phiên bản mới nhất của nội dung gốc bằng tiếng AnhNếu bạn có ý tưởng để cải thiện tài liệu này, vui lòng đóng góp bằng cách gửi pull request trên GitHub.
Liên kết GitHub tới tài liệuSao chép Markdown của tài liệu vào bộ nhớ tạm
Markdown / Nội dung Rich Text
Intlayer hỗ trợ nội dung rich text được định nghĩa bằng cú pháp Markdown. Điều này cho phép bạn dễ dàng viết và duy trì nội dung được định dạng phong phú như blog, bài viết, và hơn thế nữa.
Khai báo Nội dung Markdown
Bạn có thể khai báo nội dung Markdown bằng cách sử dụng hàm md hoặc đơn giản là một chuỗi (nếu nó chứa cú pháp Markdown).
Bắt đầu từ phiên bản 8.10.0, bạn có thể khai báo nội dung Markdown trực tiếp trong các tệp .content.md. Intlayer sẽ tự động phát hiện và phân tích nội dung Markdown.
Sao chép mã vào clipboard
Trường front-matter locale là trường xác định ngôn ngữ của nội dung. Nó là tùy chọn. Nếu không được cung cấp, Intlayer sẽ sử dụng ngôn ngữ mặc định, ngôn ngữ này cũng được sử dụng làm ngôn ngữ dự phòng nếu không có bản dịch cho một ngôn ngữ cụ thể.
Ví dụ về cấu trúc tệp:
Sao chép mã vào clipboard
Bạn có thể thêm vào front-matter bất kỳ thuộc tính nào được định nghĩa trong Định nghĩa Từ điển
Sử dụng hàm md để khai báo rõ ràng nội dung Markdown. Điều này rất hữu ích nếu bạn muốn đảm bảo một chuỗi được xử lý như Markdown ngay cả khi nó không chứa cú pháp rõ ràng.
Sao chép mã vào clipboard
Nhập trực tiếp các tệp .md bằng cách sử dụng hàm file.
Sao chép mã vào clipboard
Nếu chuỗi chứa các chỉ báo Markdown phổ biến (như tiêu đề, danh sách, liên kết, v.v.), Intlayer sẽ tự động chuyển đổi nó.
Sao chép mã vào clipboard
Render Markdown
Intlayer cung cấp hai cách độc lập để render Markdown:
Thông qua
useIntlayer— Intlayer tự động chuyển đổi nodemdthành đầu ra nguyên bản của framework (JSX, VNode, chuỗi HTML).- Frontmatter được phân tích cú pháp và hiển thị dưới dạng
.metadata. Bạn có thể ghi đè quá trình render ở hai cấp độ — toàn cục vớiMarkdownProvider(hoặc tương đương trong framework) và cục bộ trên mỗi node bằng.use(). Cả hai đều có thể được kết hợp;.use()được ưu tiên hơnMarkdownProvider, vàMarkdownProviderđược ưu tiên hơn mặc định.
- Frontmatter được phân tích cú pháp và hiển thị dưới dạng
Các tiện ích hỗ trợ —
<MarkdownRenderer />,useMarkdownRenderer(), vàrenderMarkdown()là các công cụ độc lập chấp nhận chỉ các chuỗi Markdown thô. Chúng độc lập vớiuseIntlayervà không hoạt động với các node được trang trí mà nó trả về.
Render Markdown hỗ trợ MDX — sử dụng bất kỳ component JSX/framework nào bằng tên trực tiếp bên trong Markdown của bạn.
1. Render Tự động (thông qua useIntlayer)
Các node Markdown có thể được render trực tiếp dưới dạng JSX.
Sao chép mã vào clipboard
Nếu không có MarkdownProvider, Intlayer sẽ render markdown bằng cách sử dụng trình phân tích cú pháp Markdown sang JSX mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Các node Markdown có thể được render trực tiếp dưới dạng JSX.
Sao chép mã vào clipboard
Nếu không có MarkdownProvider, Intlayer sẽ render markdown bằng cách sử dụng trình phân tích cú pháp Markdown sang JSX mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Trong Vue, nội dung Markdown có thể được render bằng thẻ component tích hợp sẵn hoặc trực tiếp như một node.
Sao chép mã vào clipboard
Cấu hình toàn cục thông qua plugin intlayerMarkdown (hỗ trợ các component tùy chỉnh MDX):
Sao chép mã vào clipboard
Nếu plugin intlayerMarkdown không được cài đặt, Intlayer sẽ render bằng trình biên dịch mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Svelte render Markdown thành một chuỗi HTML theo mặc định. Sử dụng {@html} để render nó.
Sao chép mã vào clipboard
Nếu không có MarkdownProvider, Intlayer sẽ render markdown bằng trình biên dịch mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Preact hỗ trợ các node Markdown trực tiếp trong JSX.
Sao chép mã vào clipboard
Nếu không có MarkdownProvider, Intlayer sẽ render markdown bằng trình phân tích cú pháp Markdown sang JSX mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Solid hỗ trợ các node Markdown trực tiếp trong JSX.
Sao chép mã vào clipboard
Nếu không có MarkdownProvider, Intlayer sẽ render markdown bằng trình phân tích cú pháp Markdown sang JSX mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
Angular sử dụng chỉ thị [innerHTML] để render nội dung Markdown.
Sao chép mã vào clipboard
Nếu provider IntlayerMarkdown không được cấu hình, Intlayer sẽ render bằng trình biên dịch mặc định.
Bạn cũng có thể cung cấp các ghi đè cục bộ cho các node cụ thể bằng phương thức .use():
Sao chép mã vào clipboard
Bạn có thể lấy Markdown dưới dạng chuỗi:
Sao chép mã vào clipboard
Và bạn có thể truy cập siêu dữ liệu markdown của mình như sau:
Sao chép mã vào clipboard
2. Các tiện ích hỗ trợ (Chỉ Chuỗi Markdown)
Các tiện ích này chỉ render các chuỗi Markdown thô và độc lập với useIntlayer. Hãy sử dụng chúng khi bạn cần render Markdown từ các nguồn khác ngoài từ điển của bạn.
Component <MarkdownRenderer />
Render một chuỗi Markdown với các tùy chọn cụ thể.
Sao chép mã vào clipboard
Hook useMarkdownRenderer()
Nhận một hàm render đã được cấu hình trước.
Sao chép mã vào clipboard
Tiện ích renderMarkdown()
Tiện ích độc lập để render bên ngoài các component.
Sao chép mã vào clipboard
Component <MarkdownRenderer />
Render một chuỗi Markdown với các tùy chọn cụ thể.
Sao chép mã vào clipboard
Hook useMarkdownRenderer()
Nhận một hàm render đã được cấu hình trước.
Sao chép mã vào clipboard
Tiện ích renderMarkdown()
Tiện ích độc lập để render bên ngoài các component.
Sao chép mã vào clipboard
Component <MarkdownRenderer />
Sao chép mã vào clipboard
Component <MarkdownRenderer />
Sao chép mã vào clipboard
Hook useMarkdownRenderer()
Sao chép mã vào clipboard
Tiện ích renderMarkdown()
Sao chép mã vào clipboard
Component <MarkdownRenderer />
Sao chép mã vào clipboard
Hook useMarkdownRenderer()
Sao chép mã vào clipboard
Tiện ích renderMarkdown()
Sao chép mã vào clipboard
Component <MarkdownRenderer />
Sao chép mã vào clipboard
Hook useMarkdownRenderer()
Sao chép mã vào clipboard
Tiện ích renderMarkdown()
Sao chép mã vào clipboard
Service IntlayerMarkdownService
Render một chuỗi Markdown sử dụng service.
Sao chép mã vào clipboard
Cấu hình Toàn cục với MarkdownProvider
MarkdownProvider (hoặc tương đương trong framework) cấu hình pipeline render Markdown cho toàn bộ ứng dụng của bạn. Điều này áp dụng cho cả render useIntlayer tự động và các tiện ích hỗ trợ. Các tùy chọn được đặt ở đây là mặc định — .use() sẽ ghi đè chúng ở cấp độ node.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Sao chép mã vào clipboard
Hỗ trợ MDX — bất kỳ tên component nào được sử dụng bên trong Markdown của bạn (ví dụ:<MyCustomJSXComponent />) đều được phân giải dựa trên bản đồcomponents.
Bạn cũng có thể sử dụng trình render markdown của riêng mình:
Sao chép mã vào clipboard
Việc nhập trình render Markdown của bạn một cách động là một cách tuyệt vời để giảm dung lượng bundle của ứng dụng.
Suspense
Trình kết xuất Markdown của Intlayer được tải động. Mặc dù được tối ưu hóa, đoạn phân tích cú pháp cơ bản là khoảng 55kb. Tải điều này đồng bộ sẽ trì hoãn kết xuất trang ban đầu và làm suy giảm First Contentful Paint (FCP).
Để ngăn chặn việc chặn giao diện người dùng, Intlayer tích hợp với Suspense API của React. Nó tìm nạp trình phân tích cú pháp trong nền và ném Promise trong khi tải xuống.
Bọc bất kỳ thành phần nào kết xuất Intlayer Markdown trong ranh giới <Suspense>. Điều này hiển thị trạng thái dự phòng được bản địa hóa trong khi đoạn phim tải xuống, cho phép phần còn lại của DOM của bạn kết xuất ngay lập tức.
Cảnh báo: Nếu bạn không cung cấp ranh giới <Suspense>, React sẽ đình chỉ ở cấp gốc hoặc chặn toàn bộ cây thành phần khỏi kết xuất cho đến khi đoạn 55kb được tải hoàn toàn.
Trong Next.js App Router, bạn có thể sử dụng React Suspense cho các thành phần máy khách hoặc tệp loading.tsx cho các thành phần máy chủ.
Thành phần máy khách:
Sao chép mã vào clipboard
Thành phần máy chủ với loading.tsx:
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Vue có một thành phần <Suspense> được tích hợp sẵn. Bọc thành phần kết xuất nội dung Markdown trong ranh giới <Suspense>.
Sao chép mã vào clipboard
Svelte không có Suspense API tương đương. Sử dụng khối {#await} để xử lý kết xuất không đồng bộ của nội dung Markdown.
Sao chép mã vào clipboard
Preact hỗ trợ Suspense API của React thông qua preact/compat.
Sao chép mã vào clipboard
Solid có thành phần <Suspense> riêng biệt từ solid-js.
Sao chép mã vào clipboard
Angular không có Suspense API. Sử dụng chế độ xem có thể trì hoãn (@defer) của Angular để xử lý nội dung Markdown được tải chậm (yêu cầu Angular 17+).
Sao chép mã vào clipboard
Render Phía Server (SSR) và Hydrat Hóa
So với các trình phân tích cú pháp Markdown khác như remark / rehype, Intlayer Markdown không phụ thuộc và chạy trên cả client lẫn server.
Nhưng Intlayer tối ưu hóa việc phân tích cú pháp cho các framework Server-Side Rendering (SSR) (như Next.js App Router, React Router, Nuxt, SvelteKit, v.v.).
Thay vì gửi chuỗi Markdown thô đến client và phân tích cú pháp trên trình duyệt (gây giảm hiệu suất), Intlayer cho phép bạn phân tích cú pháp trước Markdown thành Cây Cú Pháp Trừu Tượng (AST) trên server.
Bạn có thể sử dụng hàm parseMarkdown từ gói Intlayer của framework phía server để tạo ra một AST có thể tuần tự hóa (đối tượng ParsedMarkdown), và chuyển trực tiếp đến frontend. Tất cả các tiện ích render của Intlayer (như <MarkdownRenderer>, useMarkdownRenderer, v.v.) tự động chấp nhận đối tượng AST này và hiển thị nó một cách liền mạch.
Ví dụ trong Kiến Trúc Server/Client
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Angular SSR thường giải quyết dữ liệu trên server trong lần tải đầu tiên và hydrat hóa trên client. Bạn có thể sử dụng resolver để truyền AST.
Sao chép mã vào clipboard
Sao chép mã vào clipboard
Mẫu này đảm bảo logic phân tích cú pháp Markdown được thực thi hoàn toàn trên server, giảm đáng kể thời gian thực thi phía client và cải thiện tốc độ hydrat hóa ban đầu.
Tham chiếu tùy chọn
Các tùy chọn này có thể được truyền đến MarkdownProvider, MarkdownRenderer, useMarkdownRenderer và renderMarkdown.
Mở bảng trong một cửa sổ bật lên để xem toàn bộ nội dung dữ liệu một cách rõ ràng
| Option | Type | Default | Mô tả |
|---|---|---|---|
forceBlock | boolean | false | Bắt buộc đầu ra phải được bọc trong một phần tử cấp khối (ví dụ: <div>). |
forceInline | boolean | false | Bắt buộc đầu ra phải được bọc trong một phần tử nội tuyến (ví dụ: <span>). |
tagfilter | boolean | true | Bật Bộ lọc thẻ GitHub để cải thiện bảo mật bằng cách loại bỏ các thẻ HTML nguy hiểm. |
preserveFrontmatter | boolean | false | Nếu true, frontmatter ở đầu chuỗi Markdown sẽ không bị tước đi. |
components | Overrides | {} | Bản đồ các thẻ HTML cho các thành phần tùy chỉnh (ví dụ: { h1: MyHeading }). |
wrapper | Component | null | Thành phần tùy chỉnh để bọc Markdown đã kết xuất. |
renderMarkdown | Function | null | Chức năng kết xuất tùy chỉnh để thay thế hoàn toàn trình biên dịch Markdown mặc định. |
