mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-04 04:37:28 +02:00
28 lines
1.2 KiB
Text
28 lines
1.2 KiB
Text
---
|
|
id: markdown-features
|
|
title: Docs Markdown Features
|
|
description: Docusaurus Markdown features that are specific to the docs plugin
|
|
slug: /docs-markdown-features
|
|
---
|
|
|
|
Docs can use any [Markdown feature](../markdown-features/markdown-features-intro.mdx), and have a few additional Docs-specific markdown features.
|
|
|
|
## Markdown frontmatter {#markdown-frontmatter}
|
|
|
|
Markdown docs have their own [Markdown frontmatter](../../api/plugins/plugin-content-docs.md#markdown-frontmatter)
|
|
|
|
## Referencing other documents {#referencing-other-documents}
|
|
|
|
If you want to reference another document file, you could use the name of the document you want to reference. Docusaurus will convert the file path to be the final website path (and remove the `.md`).
|
|
|
|
For example, if you are in `doc2.md` and you want to reference `doc1.md` and `folder/doc3.md`:
|
|
|
|
```md
|
|
I am referencing a [document](doc1.md). Reference to another [document in a folder](folder/doc3.md).
|
|
|
|
[Relative document](../doc2.md) referencing works as well.
|
|
```
|
|
|
|
One benefit of this approach is that the links to external files will still work if you are viewing the file on GitHub.
|
|
|
|
Another benefit, for versioned docs, is that one versioned doc will link to another doc of the exact same version.
|