mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-19 03:02:30 +02:00
df8a900f9c
* POC: add trailingSlash option * integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin * Fix broken links when using trailing slash => using md links is more reliable * fix TS issue * minor polish * fix doc page being sensitive to trailing slashes * Add tests for applyTrailingSlash * rename test files * extract and test applyRouteTrailingSlash * update snapshot * add trailing slash config to serve command * fix getSidebar() => still sensitive to trailing slash setting * never apply trailing slash to an anchor link * Add documentation for trailingSlash setting
39 lines
1.5 KiB
Text
39 lines
1.5 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 relative path of the document you want to link to.
|
|
|
|
Docusaurus will convert the file path to be the final document url path (and remove the `.md` extension).
|
|
|
|
For example, if you are in `folder/doc1.md` and you want to reference `folder/doc2.md`, `folder/subfolder/doc3.md` and `otherFolder/doc4.md`:
|
|
|
|
```md
|
|
I am referencing a [document](doc2.md).
|
|
|
|
Reference to another [document in a subfolder](subfolder/doc3.md).
|
|
|
|
[Relative document](../otherFolder/doc4.md) referencing works as well.
|
|
```
|
|
|
|
:::tip
|
|
|
|
It is better to use relative file paths links instead of relative links:
|
|
|
|
- links will keep working on the GitHub interface
|
|
- you can customize the document slugs without having to update all the links
|
|
- a versioned doc will link to another doc of the exact same version
|
|
- relative links are very likely to break if you update the [`trailingSlash` config](../../api/docusaurus.config.js.md#trailing-slash)
|
|
|
|
:::
|