actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

⏪️ Revert "📝 Document light/dark images in `markdown.md`" 

This reverts commit 3d4721fd96.

I'm trying to get the diffs smaller. It looks like someone previously
committed code that did not strip extra spaces from the ends of lines
with their editor.
This commit is contained in:
hayesall 2023-10-22 14:32:16 -04:00
parent c05065a894
commit 658699fea6
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
guide/src/format/markdown.md
View File

@ -2,13 +2,13 @@
mdBook's [parser](https://github.com/raphlinus/pulldown-cmark) adheres to the [CommonMark](https://commonmark.org/) specification with some extensions described below.
You can take a quick [tutorial](https://commonmark.org/help/tutorial/),
or [try out](https://spec.commonmark.org/dingus/) CommonMark in real time. A complete Markdown overview is out of scope for
or [try out](https://spec.commonmark.org/dingus/) CommonMark in real time. A complete Markdown overview is out of scope for
this documentation, but below is a high level overview of some of the basics. For a more in-depth experience, check out the
[Markdown Guide](https://www.markdownguide.org).
## Text and Paragraphs
Text is rendered relatively predictably:
Text is rendered relatively predictably:
```markdown
Here is a line of text.
@ -27,20 +27,20 @@ This is a new line.
Headings use the `#` marker and should be on a line by themselves. More `#` mean smaller headings:
```markdown
### A heading
### A heading
Some text.
#### A smaller heading
#### A smaller heading
More text.
```
### A heading
### A heading
Some text.
#### A smaller heading
#### A smaller heading
More text.
@ -71,14 +71,14 @@ Lists can be unordered or ordered. Ordered lists will order automatically:
Linking to a URL or local file is easy:
```markdown
Use [mdBook](https://github.com/rust-lang/mdBook).
Use [mdBook](https://github.com/rust-lang/mdBook).
Read about [mdBook](mdbook.md).
A bare url: <https://www.rust-lang.org>.
```
Use [mdBook](https://github.com/rust-lang/mdBook).
Use [mdBook](https://github.com/rust-lang/mdBook).
Read about [mdBook](mdbook.md).
@ -122,14 +122,14 @@ Which, of course displays the image like so:
Separate light mode and dark mode images may be presented to the viewer by adding `#light-only` or `#dark-only` to an image path:
```markdown
![rust logo standard edition](images/rust-logo-blk.svg#only-light)
![rust logo dark mode](images/rust-logo-blk-dark.svg#only-dark)
<img src="images/rust-logo-blk.svg" class="no-dark-themes" />
<img src="images/rust-logo-blk-dark.svg" class="no-light-themes" />
```
Try switching the theme to see the effect below (brush icon at the top left of the page):
![rust logo standard edition](images/rust-logo-blk.svg#only-light)
![rust logo dark mode](images/rust-logo-blk-dark.svg#only-dark)
<img src="images/rust-logo-blk.svg" class="no-dark-themes" />
<img src="images/rust-logo-blk-dark.svg" class="no-light-themes" />
## Extensions