3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 07:37:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(v2): prepare v2.0.0-beta.0 release (#4774)

Browse source 
* beta.0 version docs + changelog

* fix config for beta switch

* v2.0.0-beta.0
This commit is contained in:
Sébastien Lorber 2021-05-12 16:07:15 +02:00 • committed by GitHub
parent fe6492aa87
commit 7e4d7671c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
103 changed files with 11779 additions and 149 deletions
Download patch file Download diff file Expand all files Collapse all files

28
website/versioned_docs/version-2.0.0-beta.0/guides/docs/docs-markdown-features.mdx Normal file
View file

@ -0,0 +1,28 @@
---
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.