Tạo tài liệu
Tạo tài liệu Tạo một tệp Markdown và đặt nó trong thư mục.greeting.mddocs
website # root directory of your site
├── docs
│ └── greeting.md
├── src
│ └── pages
├── docusaurus.config.js
├── ...
---
description: Create a doc page with rich content.
---
# Hello from Docusaurus
Are you ready to create the documentation site for your open source project?
## Headers
will show up on the table of contents on the upper right
So that your users will know what this page is all about without scrolling down or even without reading too much.
## Only h2 and h3 will be in the TOC by default.
You can configure the TOC heading levels either per-document or in the theme configuration.
The headers are well-spaced so that the hierarchy is clear.
- lists will help you
- present the key points
- that you want your users to remember
- and you may nest them
- multiple times
ghi Tất cả các tệp có tiền tố dưới () trong thư mục được coi là các trang "một phần" và sẽ bị bỏ qua theo mặc định._docs
Đọc thêm về nhập một phần trang.
Vấn đề phía trước của tài liệu Vấn đề phía trước được sử dụng để cung cấp siêu dữ liệu bổ sung cho trang tài liệu của bạn. Vật chất phía trước là tùy chọn — Docusaurus sẽ có thể suy ra tất cả các siêu dữ liệu cần thiết mà không cần vật chất phía trước. Ví dụ: tính năng thẻ doc được giới thiệu bên dưới yêu cầu sử dụng vật chất phía trước. Đối với tất cả các trường có thể, hãy xem tài liệu API.
Thẻ tài liệu Các thẻ được khai báo ở vấn đề phía trước và giới thiệu một khía cạnh khác của phân loại ngoài thanh bên tài liệu.
Có thể xác định thẻ nội tuyến hoặc tham chiếu các thẻ được xác định trước được khai báo trong tệp thẻ (tùy chọn, thường là ).docs/tags.yml
Trong ví dụ sau:
docusaurus tham chiếu một khóa thẻ được xác định trước được khai báo trong docs/tags.yml Releases là một thẻ nội tuyến, vì nó không tồn tại trong docs/tags.yml tài liệu/my-doc.md
---
tags:
- Releases
- docusaurus
---
# Title
Content
tài liệu/tags.yml
docusaurus:
label: 'Docusaurus'
permalink: '/docusaurus'
description: 'Docs related to the Docusaurus framework'
mẹo Thẻ cũng có thể được khai báo bằng .tags: [Demo, Getting started]
Đọc thêm về tất cả các cú pháp mảng Yaml có thể có.
Tổ chức cấu trúc thư mục Cách sắp xếp các tệp Markdown trong thư mục có thể có nhiều tác động đến việc tạo nội dung của Docusaurus. Tuy nhiên, hầu hết chúng có thể được tách rời khỏi cấu trúc tệp.docs
ID tài liệu Mỗi tài liệu có một . Theo mặc định, tài liệu là tên của tài liệu (không có phần mở rộng) liên quan đến thư mục tài liệu gốc.idid
Ví dụ: ID của là , và ID của là .greeting.mdgreetingguide/hello.mdguide/hello
website # Root directory of your site
└── docs
├── greeting.md
└── guide
└── hello.md
Tuy nhiên, phần cuối cùng của có thể được xác định bởi người dùng ở vấn đề phía trước. Ví dụ: nếu nội dung của ' được định nghĩa như bên dưới, thì cuối cùng của nó là .idguide/hello.mdidguide/part1
---
id: part1
---
Lorem ipsum
ID được sử dụng để tham chiếu đến tài liệu khi thanh bên viết tay hoặc khi sử dụng các thành phần hoặc móc bố cục liên quan đến tài liệu.
URL tài liệu Theo mặc định, vị trí URL của tài liệu là đường dẫn tệp của nó so với thư mục, với một số ngoại lệ. Cụ thể, nếu một tệp được đặt tên như sau, tên tệp sẽ không được đưa vào URL:docs
Được đặt tên là (không phân biệt chữ hoa chữ thường): indexdocs/Guides/index.md
Được đặt tên là (không phân biệt chữ hoa chữ thường): READMEdocs/Guides/README.mdx
Cùng tên với thư mục mẹ: docs/Guides/Guides.md
Trong mọi trường hợp, sên mặc định sẽ chỉ là , không có , hoặc phân đoạn trùng lặp./Guides/index/README/Guides
ghi Quy ước này hoàn toàn giống với quy ước chỉ mục thể loại. Tuy nhiên, cấu hình không ảnh hưởng đến URL tài liệu.isCategoryIndex
Sử dụng vấn đề phía trước để thay đổi URL của tài liệu.slug
Ví dụ: giả sử cấu trúc trang web của bạn trông như sau:
website # Root directory of your site
└── docs
└── guide
└── hello.md
Theo mặc định sẽ có sẵn tại . Bạn có thể thay đổi vị trí URL của nó thành:hello.md/docs/guide/hello/docs/bonjour
---
slug: /bonjour
---
Lorem ipsum
slug sẽ được thêm vào plugin doc theo mặc định. Xem Chế độ chỉ tài liệu để biết cách xóa phần khỏi URL.routeBasePath/docs/docs
ghi Có thể sử dụng:
Sên tuyệt đối: , ...slug: /mySlugslug: / Sên tương đối: , ...slug: mySlugslug: ./../mySlug Nếu bạn muốn một tài liệu có sẵn ở gốc và có một đường dẫn như , bạn có thể sử dụng vấn đề phía trước sên:https://docusaurus.io/docs/
---
id: my-home-doc
slug: /
---
Lorem ipsum
Sidebars Khi sử dụng thanh bên được tạo tự động, cấu trúc tệp sẽ xác định cấu trúc thanh bên.
Khuyến nghị của chúng tôi cho tổ chức hệ thống tệp là: làm cho hệ thống tệp của bạn phản ánh cấu trúc thanh bên (vì vậy bạn không cần phải viết tay tệp của mình) và sử dụng vấn đề phía trước để tùy chỉnh URL của mỗi tài liệu.sidebars.jsslug