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

📝 Document light/dark images in `markdown.md`

This commit is contained in:
hayesall 2023-10-22 13:24:43 -04:00
parent c42569b8d6
commit 3d4721fd96
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. 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/), 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 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). [Markdown Guide](https://www.markdownguide.org).
## Text and Paragraphs ## Text and Paragraphs
Text is rendered relatively predictably: Text is rendered relatively predictably:
```markdown ```markdown
Here is a line of text. 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: Headings use the `#` marker and should be on a line by themselves. More `#` mean smaller headings:
```markdown ```markdown
### A heading ### A heading
Some text. Some text.
#### A smaller heading #### A smaller heading
More text. More text.
``` ```
### A heading ### A heading
Some text. Some text.
#### A smaller heading #### A smaller heading
More text. 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: Linking to a URL or local file is easy:
```markdown ```markdown
Use [mdBook](https://github.com/rust-lang/mdBook). Use [mdBook](https://github.com/rust-lang/mdBook).
Read about [mdBook](mdbook.md). Read about [mdBook](mdbook.md).
A bare url: <https://www.rust-lang.org>. 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). Read about [mdBook](mdbook.md).
@ -124,14 +124,14 @@ Image variants for different themes can be used via CSS classes.
Here is an example for different images for light vs. dark themes: Here is an example for different images for light vs. dark themes:
```markdown ```markdown
<img src="images/rust-logo-blk.svg" class="no-dark-themes" /> ![rust logo standard edition](images/rust-logo-blk.svg#only-light)
<img src="images/rust-logo-blk-dark.svg" class="no-light-themes" /> ![rust logo dark mode](images/rust-logo-blk-dark.svg#only-dark)
``` ```
Try switching the theme to see the effect below (brush icon at the top left of the page): Try switching the theme to see the effect below (brush icon at the top left of the page):
<img src="images/rust-logo-blk.svg" class="no-dark-themes" /> ![rust logo standard edition](images/rust-logo-blk.svg#only-light)
<img src="images/rust-logo-blk-dark.svg" class="no-light-themes" /> ![rust logo dark mode](images/rust-logo-blk-dark.svg#only-dark)
To exclude an image (or any HTML element) for all dark or all light themes To exclude an image (or any HTML element) for all dark or all light themes
(incl. the Rust theme), use the classes `no-dark-themes` and `no-light-themes`. (incl. the Rust theme), use the classes `no-dark-themes` and `no-light-themes`.