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

docs: use BrowserWindow for Markdown demos (#6215)

Browse source
This commit is contained in:
Joshua Chen 2021-12-29 13:49:09 +08:00 • committed by GitHub
parent 5132ecdeee
commit 0fa091a0c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 101 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/docs/guides/markdown-features/markdown-features-intro.mdx
View file

@ -6,9 +6,7 @@ description: Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about
slug: /markdown-features
---
```mdx-code-block
import BrowserWindow from '@site/src/components/BrowserWindow';
```
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.
@ -58,10 +56,14 @@ Markdown quotes are beautifully styled:
> — Docusaurus
```
<BrowserWindow>
> Easy to maintain open source documentation websites.
>
> — Docusaurus
</BrowserWindow>
## Details
Markdown can embed HTML elements, and [`details`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details) HTML elements are beautifully styled:
@ -108,8 +110,6 @@ Markdown can embed HTML elements, and [`details`](https://developer.mozilla.org/
</details>
</BrowserWindow>
<br/>
```
:::note