Skip to content

Commit c63000f

Browse files
joshrotenbergjoshrotenberg
committed
Merge remote-tracking branch 'upstream/master' into update-pulldown-cmark
2 parents 903469a + 17d1ed3 commit c63000f

26 files changed

+1415
-2
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ guide/book
88

99
.vscode
1010
tests/dummy_book/book/
11+
test_book/book/
1112

1213
# Ignore Jetbrains specific files.
1314
.idea/

‎src/book/mod.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,7 @@ impl MDBook {
276276
cmd.args(&["--edition", "2018"]);
277277
}
278278
RustEdition::E2021 => {
279-
cmd.args(&["--edition", "2021"])
280-
.args(&["-Z", "unstable-options"]);
279+
cmd.args(&["--edition", "2021"]);
281280
}
282281
}
283282
}

‎test_book/book.toml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[book]
2+
title = "mdBook test book"
3+
description = "A demo book to test and validate changes"
4+
authors = ["YJDoc2"]
5+
language = "en"
6+
7+
[rust]
8+
edition = "2018"
9+
10+
[output.html]
11+
mathjax-support = true
12+
13+
[output.html.playground]
14+
editable = true
15+
line-numbers = true
16+
17+
[output.html.search]
18+
limit-results = 20
19+
use-boolean-and = true
20+
boost-title = 2
21+
boost-hierarchy = 2
22+
boost-paragraph = 1
23+
expand = true
24+
heading-split-level = 2
25+
26+
[output.html.redirect]
27+
"/format/config.html" = "configuration/index.html"

‎test_book/src/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Demo Book
2+
3+
This is a simple demo book, which is intended to be used for verifying and validating style changes in mdBook.
4+
This contains dummy examples of various markdown elements and code languages, so that one can check changes made in mdBook styles.
5+
6+
This rough outline is :
7+
8+
- individual : contains basic markdown elements such as headings, paragraphs, links etc.
9+
- languages : contains a `hello world` in each of supported language to see changes in syntax highlighting
10+
- rust : contains language examples specific to rust, such as play pen, runnable examples etc.
11+
12+
This is more for checking and fixing style, rather than verifying that correct code is generated for given markdown, that is better handled in tests.

‎test_book/src/SUMMARY.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Summary
2+
3+
[Prefix Chapter](prefix.md)
4+
5+
---
6+
7+
- [Introduction](README.md)
8+
- [Draft Chapter]()
9+
10+
# Actual Markdown Tag Examples
11+
12+
- [Markdown Individual tags](individual/README.md)
13+
- [Heading](individual/heading.md)
14+
- [Paragraphs](individual/paragraph.md)
15+
- [Line Break](individual/linebreak.md)
16+
- [Emphasis](individual/emphasis.md)
17+
- [Blockquote](individual/blockquote.md)
18+
- [List](individual/list.md)
19+
- [Code](individual/code.md)
20+
- [Image](individual/image.md)
21+
- [Links and Horizontal Rule](individual/link_hr.md)
22+
- [Tables](individual/table.md)
23+
- [Tasks](individual/task.md)
24+
- [Strikethrough](individual/strikethrough.md)
25+
- [Mixed](individual/mixed.md)
26+
- [Languages](languages/README.md)
27+
- [Syntax Highlight](languages/highlight.md)
28+
- [Rust Specific](rust/README.md)
29+
- [Rust Codeblocks](rust/rust_codeblock.md)
30+
31+
---
32+
33+
[Suffix Chapter](suffix.md)

‎test_book/src/individual/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Individual Common mark tags
2+
3+
This contains following tags:
4+
5+
- Headings
6+
- Paragraphs
7+
- Line breaks
8+
- Emphasis
9+
- Blockquotes
10+
- Lists
11+
- Code blocks
12+
- Images
13+
- Links and Horizontal rules
14+
- Github tables
15+
- Github Task Lists
16+
- Strikethrough
17+
- Mixed

‎test_book/src/individual/blockquote.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Blockquote
2+
3+
> This is a quoted sentence.
4+
5+
> This is a quoted paragraph
6+
>
7+
> separated lines
8+
> here
9+
10+
> Nested
11+
>
12+
> > Quoted
13+
> > Paragraph
14+
15+
> ### And now,
16+
>
17+
> **Let us _introduce_**
18+
> All kinds of
19+
>
20+
> - tags
21+
> - etc
22+
> - stuff
23+
>
24+
> 1. In
25+
> 2. The
26+
> 3. blockquote
27+
>
28+
> > cause we can
29+
> >
30+
> > > Cause we can

‎test_book/src/individual/code.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Code
2+
3+
This section only does simple code blocks and inline code, detailed syntax highlight and stuff is in the languages section
4+
5+
---
6+
7+
```
8+
This is a codeblock
9+
```
10+
11+
---
12+
13+
This line contains `inline code`
14+
15+
---
16+
17+
````
18+
escaping ``` in ```, fun, isn't is?
19+
````
20+
21+
---
22+
23+
```bash,editable
24+
This is an editable codeblock
25+
```
26+
27+
---
28+
29+
```rust
30+
// This links to a playpen
31+
```

‎test_book/src/individual/emphasis.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Emphasis
2+
3+
This has **bold text** in between normal.
4+
5+
This has _italic text_ in between normal.
6+
7+
A **line** having _both_, bold and italic text.
8+
9+
**A bold line _having_ italic text**
10+
11+
_An Italic line having **bold** text_
12+
13+
Now this is going **_out of hands_**.

‎test_book/src/individual/heading.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Chapter Heading
2+
3+
---
4+
5+
# Really Big Heading
6+
7+
## Big Heading
8+
9+
### Normal-ish Heading
10+
11+
#### Small Heading...?
12+
13+
##### Really Small Heading
14+
15+
###### Is it even a heading anymore - heading

‎test_book/src/individual/image.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Images
2+
3+
For copyright and trademark information on these images, please check [rust-artwork repository](https://github.com/rust-lang/rust-artworkhttps://github.com/rust-lang/rust-artwork)
4+
5+
## A 16x16 image
6+
7+
![16x16 rust-lang logo](http://rust-lang.org/logos/rust-logo-16x16.png)
8+
9+
## A 32x32 image
10+
11+
![32x32 rust-lang logo](http://rust-lang.org/logos/rust-logo-32x32-blk.png)
12+
13+
## A 256x256 image
14+
15+
![256x256 rust-lang logo](http://rust-lang.org/logos/rust-logo-256x256.png)
16+
17+
## A 512x512 image
18+
19+
![512x512 rust-lang logo](http://rust-lang.org/logos/rust-logo-512x512-blk.png)
20+
21+
## A large image
22+
23+
![2018 rust-conf art](https://raw.githubusercontent.com/rust-lang/rust-artwork/master/2018-RustConf/lucy-mountain-climber.png)
24+
25+
## A SVG image
26+
27+
![2018 rust-conf art svg](https://raw.githubusercontent.com/rust-lang/rust-artwork/461afe27d8e02451cf9f46e507f2c2a71d2b276b/2018-RustConf/lucy-mountain-climber.svg)

‎test_book/src/individual/linebreak.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Line breaks
2+
3+
This is a long
4+
line with a couple of
5+
line breaks in <br/>
6+
between : both with two
7+
spaces and return, <br/>
8+
and with HTML tags.

‎test_book/src/individual/link_hr.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Links and Horizontal Rule
2+
3+
This is followed by a Horizontal rule
4+
5+
---
6+
7+
And this is preceded by a horizontal rule.
8+
9+
[This](www.rust-lang.org) should link to rust-lang website
10+
[So should this][rl].
11+
**[This][rl]** is a strong link.
12+
_[This][rl]_ is italic.
13+
**_[This][rl]_** is both.
14+
15+
[rl]: www.rust-lang.org

‎test_book/src/individual/list.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Lists
2+
3+
1. A
4+
2. Normal
5+
3. Ordered
6+
4. List
7+
8+
---
9+
10+
1. A
11+
1. Nested
12+
2. List
13+
2. But
14+
3. Still
15+
4. Normal
16+
17+
---
18+
19+
- An
20+
- Unordered
21+
- Normal
22+
- List
23+
24+
---
25+
26+
- Nested
27+
- Unordered
28+
- List
29+
30+
---
31+
32+
- This
33+
1. Is
34+
2. Normal
35+
- ?!

‎test_book/src/individual/mixed.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Mixed
2+
3+
This contains all tags randomly mixed together, to make sure style changes in one does not affect others.
4+
5+
### A heading
6+
7+
**Quite a Strong statement , to make**
8+
9+
~~No, cross that~~
10+
11+
> Whose **quote** is this
12+
>
13+
> > And ~~this~~
14+
> >
15+
> > > - and
16+
> > > - this
17+
> > > - also
18+
19+
```
20+
You encountered a wild codepen
21+
```
22+
23+
```rust,editable
24+
// The codepen is editable and runnable
25+
fn main(){
26+
println!("Hello world!");
27+
}
28+
```
29+
30+
A random image sprinkled in between
31+
32+
![16x16 rust-lang logo](http://rust-lang.org/logos/rust-logo-16x16.png)
33+
34+
---
35+
36+
- ~~An unordered list~~
37+
- **Hello**
38+
- _World_
39+
- What
40+
1. Should
41+
2. be
42+
3. `put`
43+
4. here?
44+
45+
| col1 | col2 | col 3 | col 4 | col 5 | col 6 |
46+
| ---- | ---- | ----- | ----- | ----- | ----- |
47+
| val1 | val2 | val3 | val5 | val4 | val6 |
48+
49+
| col1 | col2 | col 3 | An Questionable table header | col 5 | col 6 |
50+
| ---- | ---- | ----- | ---------------------------- | ----- | ---------------------------------------- |
51+
| val1 | val2 | val3 | val5 | val4 | An equally Questionable long table value |
52+
53+
### Things to do
54+
55+
- [x] Add individual tags
56+
- [ ] Add language examples
57+
- [ ] Add rust specific examples
58+
59+
And another image
60+
61+
![2018 rust-conf art svg](https://raw.githubusercontent.com/rust-lang/rust-artwork/461afe27d8e02451cf9f46e507f2c2a71d2b276b/2018-RustConf/lucy-mountain-climber.svg)

‎test_book/src/individual/paragraph.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Just a simple paragraph.
2+
3+
Let's stress test this.
4+
5+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer elit lorem, eleifend eu leo sit amet, suscipit feugiat libero. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Proin congue lectus sit amet lacus venenatis, ac sollicitudin purus condimentum. Suspendisse pretium volutpat sapien at gravida. In tincidunt, sem non accumsan consectetur, leo libero porttitor dolor, at imperdiet erat nibh quis leo. Cras dictum erat augue, quis pharetra justo porttitor posuere. Aenean sed lacinia justo, vel suscipit nisl. Etiam eleifend id mauris at gravida. Aliquam molestie cursus lorem pulvinar sollicitudin. Nam et ex dignissim, posuere sem non, pellentesque lacus. Morbi vulputate sed lorem et convallis. Duis non turpis eget elit posuere volutpat. Donec accumsan euismod enim, id consequat ex rhoncus ac. Pellentesque ac felis nisl. Duis imperdiet vel tellus ac iaculis.
6+
7+
Vivamus nec tempus enim. Integer in ligula eget elit ornare vulputate id et est. Proin mi elit, sagittis nec urna et, iaculis imperdiet neque. Vestibulum placerat cursus dolor. Donec eu sodales nulla. Praesent ac tellus eros. Donec venenatis ligula id ex porttitor malesuada. Aliquam maximus, nisi in fringilla finibus, ante elit rhoncus dui, placerat semper nisl tellus quis odio. Cras luctus magna ultrices dolor pharetra volutpat. Maecenas non enim vitae ligula efficitur aliquet id quis quam. In sagittis mollis magna eu porta. Morbi at nulla et ante elementum pharetra in sed est. Nam commodo purus enim.
8+
9+
Ut non elit sit amet urna luctus facilisis vel et sapien. Morbi nec metus at libero imperdiet sollicitudin eget quis lacus. Donec in ipsum at enim accumsan tempor vel sed magna. Aliquam non imperdiet neque. Etiam pharetra neque sed pretium interdum. Suspendisse potenti. Phasellus varius, lectus quis dapibus faucibus, purus mauris accumsan nibh, vel tempor quam metus nec sem. Nunc sagittis suscipit lorem eu finibus. Nullam augue leo, imperdiet vel diam et, vulputate scelerisque turpis. Nullam ut volutpat diam. Praesent cursus accumsan dui a commodo. Vivamus sed libero sed turpis facilisis rutrum id sed ligula. Ut id sollicitudin dui. Nulla pulvinar commodo lectus. Cras ut quam congue, consectetur dolor ac, consequat ante.
10+
11+
Curabitur scelerisque sed leo eu facilisis. Nam faucibus neque eget dictum hendrerit. Duis efficitur ex sed vulputate volutpat. Praesent condimentum nisl ac sapien efficitur laoreet. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut ut nibh elit. Nunc a neque lobortis, tempus diam vitae, interdum magna. Aenean eget nisl sed justo volutpat interdum. Mauris malesuada ex nisl, a dignissim dui elementum eget. Suspendisse potenti.
12+
13+
Praesent congue fringilla sem sed faucibus. Vivamus malesuada eget mauris at molestie. In sed faucibus nulla. Vivamus elementum accumsan metus quis suscipit. Maecenas interdum est nulla. Cras volutpat cursus nibh quis sollicitudin. Morbi vitae massa laoreet, aliquet tellus quis, consectetur ipsum. Mauris euismod congue purus non condimentum. Etiam laoreet mi vel sem consectetur gravida. Vestibulum volutpat magna nunc, vitae ultrices risus commodo eu.
14+
15+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer elit lorem, eleifend eu leo sit amet, suscipit feugiat libero. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Proin congue lectus sit amet lacus venenatis, ac sollicitudin purus condimentum. Suspendisse pretium volutpat sapien at gravida. In tincidunt, sem non accumsan consectetur, leo libero porttitor dolor, at imperdiet erat nibh quis leo. Cras dictum erat augue, quis pharetra justo porttitor posuere. Aenean sed lacinia justo, vel suscipit nisl. Etiam eleifend id mauris at gravida. Aliquam molestie cursus lorem pulvinar sollicitudin. Nam et ex dignissim, posuere sem non, pellentesque lacus. Morbi vulputate sed lorem et convallis. Duis non turpis eget elit posuere volutpat. Donec accumsan euismod enim, id consequat ex rhoncus ac. Pellentesque ac felis nisl. Duis imperdiet vel tellus ac iaculis.
16+
17+
Vivamus nec tempus enim. Integer in ligula eget elit ornare vulputate id et est. Proin mi elit, sagittis nec urna et, iaculis imperdiet neque. Vestibulum placerat cursus dolor. Donec eu sodales nulla. Praesent ac tellus eros. Donec venenatis ligula id ex porttitor malesuada. Aliquam maximus, nisi in fringilla finibus, ante elit rhoncus dui, placerat semper nisl tellus quis odio. Cras luctus magna ultrices dolor pharetra volutpat. Maecenas non enim vitae ligula efficitur aliquet id quis quam. In sagittis mollis magna eu porta. Morbi at nulla et ante elementum pharetra in sed est. Nam commodo purus enim.
18+
19+
Ut non elit sit amet urna luctus facilisis vel et sapien. Morbi nec metus at libero imperdiet sollicitudin eget quis lacus. Donec in ipsum at enim accumsan tempor vel sed magna. Aliquam non imperdiet neque. Etiam pharetra neque sed pretium interdum. Suspendisse potenti. Phasellus varius, lectus quis dapibus faucibus, purus mauris accumsan nibh, vel tempor quam metus nec sem. Nunc sagittis suscipit lorem eu finibus. Nullam augue leo, imperdiet vel diam et, vulputate scelerisque turpis. Nullam ut volutpat diam. Praesent cursus accumsan dui a commodo. Vivamus sed libero sed turpis facilisis rutrum id sed ligula. Ut id sollicitudin dui. Nulla pulvinar commodo lectus. Cras ut quam congue, consectetur dolor ac, consequat ante.
20+
21+
Curabitur scelerisque sed leo eu facilisis. Nam faucibus neque eget dictum hendrerit. Duis efficitur ex sed vulputate volutpat. Praesent condimentum nisl ac sapien efficitur laoreet. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut ut nibh elit. Nunc a neque lobortis, tempus diam vitae, interdum magna. Aenean eget nisl sed justo volutpat interdum. Mauris malesuada ex nisl, a dignissim dui elementum eget. Suspendisse potenti.
22+
23+
Praesent congue fringilla sem sed faucibus. Vivamus malesuada eget mauris at molestie. In sed faucibus nulla. Vivamus elementum accumsan metus quis suscipit. Maecenas interdum est nulla. Cras volutpat cursus nibh quis sollicitudin. Morbi vitae massa laoreet, aliquet tellus quis, consectetur ipsum. Mauris euismod congue purus non condimentum. Etiam laoreet mi vel sem consectetur gravida. Vestibulum volutpat magna nunc, vitae ultrices risus commodo eu.
24+
25+
Hopefully everything above was rendered nicely, on both desktop and mobile.

‎test_book/src/individual/strikethrough.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Strikethrough
2+
3+
~~This is Striked~~
4+
5+
~~This is **strong**, _italic_ , **_both_** and striked~~

0 commit comments

Comments
 (0)