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

chore(v2): prepare v2.0.0-beta.3 release (#5098)

Browse source 
* beta.3

* publish guide

* publish guide

* v2.0.0-beta.3
This commit is contained in:
Sébastien Lorber 2021-06-30 16:05:49 +02:00 • committed by GitHub
parent 9b9f38cd50
commit 1ec2c95e3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 12168 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

23
website/versioned_docs/version-2.0.0-beta.3/guides/markdown-features/markdown-features-intro.mdx Normal file
View file

@ -0,0 +1,23 @@
---
id: introduction
title: Markdown Features introduction
sidebar_label: Introduction
description: Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific features when writing Markdown.
slug: /markdown-features
---
Documentation is one of your product's interfaces with your users. A well-written and well-organized set of docs helps your users understand your product quickly. Our aligned goal here is to help your users find and understand the information they need, as quickly as possible.
Docusaurus 2 uses modern tooling to help you compose your interactive documentations with ease. You may embed React components, or build live coding blocks where your users may play with the code on the spot. Start sharing your eureka moments with the code your audience cannot walk away from. It is perhaps the most effective way of attracting potential users.
In this section, we'd like to introduce you to the tools we've picked that we believe will help you build a powerful documentation. Let us walk you through with an example.
Markdown is a syntax that enables you to write formatted content in a readable syntax.
The [standard Markdown syntax](https://daringfireball.net/projects/markdown/syntax) is supported, and we use [MDX](https://mdxjs.com/) as the parsing engine, which can do much more than just parsing Markdown, like rendering React components inside your documents.
:::important
This section assumes you are using the official Docusaurus content plugins.
:::