Introdução à documentação
O recurso docs fornece aos usuários uma maneira de organizar arquivos Markdown em um formato hierárquico.
Verifique a documentação de referência da API do plug-in do Docs para obter uma lista completa de opções.
ID do documento
Cada documento tem um id
único. Por padrão, um id
de documento é o nome do documento (sem a extensão) em relação ao diretório de documentos de raiz.
Por exemplo, greeting.md
id é greeting
e guide/hello.md
id é guide/hello
.
website # Root directory of your site
└── docs
├── greeting.md
└── guide
└── hello.md
However, the last part of the id
can be defined by the user in the front matter. Por exemplo, se o conteúdo do guide/hello.md
for definido como abaixo, seu id
final é guide/part1
.
---
id: part1
---
Lorem ipsum
Customizing doc URLs
By default, a document's URL location is its file path relative to the docs
folder. Use the slug
front matter to change a document's URL.
For example, suppose your site structure looks like this:
website # Root directory of your site
└── docs
└── guide
└── hello.md
By default hello.md
will be available at /docs/guide/hello
. You can change its URL location to /docs/bonjour
:
---
slug: /bonjour
---
Lorem ipsum
slug
will be appended to the doc plugin's routeBasePath
, which is /docs
by default. See Docs-only mode for how to remove the /docs
part from the URL.
É possível usar:
- slugs absolutas:
slug: /mySlug
,slug: /
... - slugs relativas:
slug: mySlug
,slug: ./../mySlug
...
Documentação da página inicial
If you want a document to be available at the root, and have a path like https://docusaurus.io/docs/
, you can use the slug front matter:
---
id: my-home-doc
slug: /
---
Lorem ipsum
Modo somente documentos
A freshly initialized Docusaurus site has the following structure:
example.com/ -> generated from `src/pages/index.js`
example.com/docs/intro -> generated from `docs/intro.md`
example.com/docs/tutorial-basics/... -> generated from `docs/tutorial-basics/...`
...
example.com/blog/2021/08/26/welcome -> generated from `blog/2021-08-26-welcome/index.md`
example.com/blog/2021/08/01/mdx-blog-post -> generated from `blog/2021-08-01-mdx-blog-post.mdx`
...
All docs will be served under the subroute docs/
. But what if your site only has docs, or you want to prioritize your docs by putting them at the root?
Assume that you have the following in your configuration:
module.exports = {
// ...
presets: [
'@docusaurus/preset-classic',
{
docs: {
/* docs plugin options */
},
blog: {
/* blog plugin options */
},
// ...
},
],
};
To enter docs-only mode, change it to like this:
module.exports = {
// ...
presets: [
'@docusaurus/preset-classic',
{
docs: {
routeBasePath: '/', // Serve the docs at the site's root
/* other docs plugin options */
},
blog: false, // Optional: disable the blog plugin
// ...
},
],
};
Note that you don't necessarily have to give up on using the blog or other plugins; all that routeBasePath: '/'
does is that instead of serving the docs through https://example.com/docs/some-doc
, they are now at the site root: https://example.com/some-doc
. The blog, if enabled, can still be accessed through the blog/
subroute.
Don't forget to put some page at the root (https://example.com/
) through adding the front matter:
---
slug: /
---
This page will be the home page when users visit https://example.com/.
If you added slug: /
to a doc to make it the homepage, you should delete the existing homepage at ./src/pages/index.js
, or else there will be two files mapping to the same route!
Now, the site's structure will be like the following:
example.com/ -> generated from `docs/intro.md`
example.com/tutorial-basics/... -> generated from `docs/tutorial-basics/...`
...
Também há um "modo somente blog" para aqueles que só querem usar o recurso do blog do Docusaurus 2. Você pode usar o mesmo método detalhado acima. Follow the setup instructions on Blog-only mode.