mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
docs(v2): change docs for markdown features (#2786)
* fix(v2): change docs for markdown features * Update doc1.md * Update doc1.md * Update doc1.md Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
This commit is contained in:
parent
faf48e9b16
commit
926cbb818b
3 changed files with 44 additions and 23 deletions
|
@ -28,9 +28,11 @@ To serve as an example page when styling markdown based Docusaurus sites.
|
|||
|
||||
## Emphasis
|
||||
|
||||
Emphasis, aka italics, with _asterisks_ or _underscores_.
|
||||
<!-- prettier-ignore -->
|
||||
Emphasis, aka italics, with *asterisks* or _underscores_.
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or **underscores**.
|
||||
<!-- prettier-ignore -->
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
|
@ -41,17 +43,22 @@ Strikethrough uses two tildes. ~~Scratch this.~~
|
|||
## Lists
|
||||
|
||||
1. First ordered list item
|
||||
1. Another item ⋅⋅\* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
|
||||
1. Another item
|
||||
- Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
1. Ordered sub-list
|
||||
1. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
To have a line break without a paragraph, you will need to use two trailing spaces. Note that this line is separate, but within the same paragraph. (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
- Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
* Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
* Or minuses
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
- Or pluses
|
||||
|
||||
|
@ -102,7 +109,7 @@ alert(s);
|
|||
|
||||
```python
|
||||
s = "Python syntax highlighting"
|
||||
print(s)
|
||||
print s
|
||||
```
|
||||
|
||||
```
|
||||
|
|
|
@ -28,9 +28,11 @@ To serve as an example page when styling markdown based Docusaurus sites.
|
|||
|
||||
## Emphasis
|
||||
|
||||
Emphasis, aka italics, with _asterisks_ or _underscores_.
|
||||
<!-- prettier-ignore -->
|
||||
Emphasis, aka italics, with *asterisks* or _underscores_.
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or **underscores**.
|
||||
<!-- prettier-ignore -->
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
|
@ -41,17 +43,22 @@ Strikethrough uses two tildes. ~~Scratch this.~~
|
|||
## Lists
|
||||
|
||||
1. First ordered list item
|
||||
1. Another item ⋅⋅\* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
|
||||
1. Another item
|
||||
- Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
1. Ordered sub-list
|
||||
1. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
To have a line break without a paragraph, you will need to use two trailing spaces. Note that this line is separate, but within the same paragraph. (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
- Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
* Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
* Or minuses
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
- Or pluses
|
||||
|
||||
|
@ -102,7 +109,7 @@ alert(s);
|
|||
|
||||
```python
|
||||
s = "Python syntax highlighting"
|
||||
print(s)
|
||||
print s
|
||||
```
|
||||
|
||||
```
|
||||
|
|
|
@ -28,9 +28,11 @@ To serve as an example page when styling markdown based Docusaurus sites.
|
|||
|
||||
## Emphasis
|
||||
|
||||
Emphasis, aka italics, with _asterisks_ or _underscores_.
|
||||
<!-- prettier-ignore -->
|
||||
Emphasis, aka italics, with *asterisks* or _underscores_.
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or **underscores**.
|
||||
<!-- prettier-ignore -->
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
|
@ -41,17 +43,22 @@ Strikethrough uses two tildes. ~~Scratch this.~~
|
|||
## Lists
|
||||
|
||||
1. First ordered list item
|
||||
1. Another item ⋅⋅\* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
|
||||
1. Another item
|
||||
- Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
1. Ordered sub-list
|
||||
1. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
To have a line break without a paragraph, you will need to use two trailing spaces. Note that this line is separate, but within the same paragraph. (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
- Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
* Unordered list can use asterisks
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
* Or minuses
|
||||
<!-- prettier-ignore -->
|
||||
|
||||
- Or pluses
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue