mirror of
https://github.com/rust-lang/mdBook
synced 2024-12-04 01:59:14 +00:00
Setup basic structure for test book
This commit is contained in:
parent
ffa8284743
commit
68f9afe64b
9 changed files with 82 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -8,6 +8,7 @@ guide/book
|
|||
|
||||
.vscode
|
||||
tests/dummy_book/book/
|
||||
test_book/book/
|
||||
|
||||
# Ignore Jetbrains specific files.
|
||||
.idea/
|
||||
|
|
27
test_book/book.toml
Normal file
27
test_book/book.toml
Normal file
|
@ -0,0 +1,27 @@
|
|||
[book]
|
||||
title = "mdBook test book"
|
||||
description = "A demo book to test and validate changes"
|
||||
authors = ["YJDoc2"]
|
||||
language = "en"
|
||||
|
||||
[rust]
|
||||
edition = "2018"
|
||||
|
||||
[output.html]
|
||||
mathjax-support = true
|
||||
|
||||
[output.html.playground]
|
||||
editable = true
|
||||
line-numbers = true
|
||||
|
||||
[output.html.search]
|
||||
limit-results = 20
|
||||
use-boolean-and = true
|
||||
boost-title = 2
|
||||
boost-hierarchy = 2
|
||||
boost-paragraph = 1
|
||||
expand = true
|
||||
heading-split-level = 2
|
||||
|
||||
[output.html.redirect]
|
||||
"/format/config.html" = "configuration/index.html"
|
12
test_book/src/README.md
Normal file
12
test_book/src/README.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
# Demo Book
|
||||
|
||||
This is a simple demo book, which is intended to be used for verifying and validating style changes in mdBook.
|
||||
This contains dummy examples of various markdown elements and code languages, so that one can check changes made in mdBook styles.
|
||||
|
||||
This rough outline is :
|
||||
|
||||
- individual : contains basic markdown elements such as headings, paragraphs, links etc.
|
||||
- languages : contains a `hello world` in each of supported language to see changes in syntax highlighting
|
||||
- rust : contains language examples specific to rust, such as play pen, runnable examples etc.
|
||||
|
||||
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.
|
18
test_book/src/SUMMARY.md
Normal file
18
test_book/src/SUMMARY.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
# Summary
|
||||
|
||||
[Prefix Chapter](prefix.md)
|
||||
|
||||
---
|
||||
|
||||
- [Introduction](README.md)
|
||||
- [Draft Chapter]()
|
||||
|
||||
# Actual Markdown Tag Examples
|
||||
|
||||
- [Markdown Individual tags](individual/README.md)
|
||||
- [Languages](languages/README.md)
|
||||
- [Rust Specific](rust/README.md)
|
||||
|
||||
---
|
||||
|
||||
[Suffix Chapter](suffix.md)
|
16
test_book/src/individual/README.md
Normal file
16
test_book/src/individual/README.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Individual Common mark tags
|
||||
|
||||
This contains following tags:
|
||||
|
||||
- Headings
|
||||
- Paragraphs
|
||||
- Line breaks
|
||||
- Emphasis
|
||||
- Blockquotes
|
||||
- Lists
|
||||
- Code blocks
|
||||
- Images
|
||||
- Links and Horizontal rules
|
||||
- Github tables
|
||||
- Github Task Lists
|
||||
- Strikethrough
|
1
test_book/src/languages/README.md
Normal file
1
test_book/src/languages/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Syntax Highlighting
|
3
test_book/src/prefix.md
Normal file
3
test_book/src/prefix.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Prefix Chapter
|
||||
|
||||
This is to verify the placement and style of prefix chapter in book index.
|
1
test_book/src/rust/README.md
Normal file
1
test_book/src/rust/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Rust specific code examples
|
3
test_book/src/suffix.md
Normal file
3
test_book/src/suffix.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Suffix Chapter
|
||||
|
||||
This is to verify the placement and style of suffix chapter in book index.
|
Loading…
Reference in a new issue