From 68f9afe64b671cfe64df1b5eee919a198e6f201e Mon Sep 17 00:00:00 2001 From: Yashodhan Joshi Date: Mon, 4 Oct 2021 13:14:49 +0530 Subject: [PATCH] Setup basic structure for test book --- .gitignore | 1 + test_book/book.toml | 27 +++++++++++++++++++++++++++ test_book/src/README.md | 12 ++++++++++++ test_book/src/SUMMARY.md | 18 ++++++++++++++++++ test_book/src/individual/README.md | 16 ++++++++++++++++ test_book/src/languages/README.md | 1 + test_book/src/prefix.md | 3 +++ test_book/src/rust/README.md | 1 + test_book/src/suffix.md | 3 +++ 9 files changed, 82 insertions(+) create mode 100644 test_book/book.toml create mode 100644 test_book/src/README.md create mode 100644 test_book/src/SUMMARY.md create mode 100644 test_book/src/individual/README.md create mode 100644 test_book/src/languages/README.md create mode 100644 test_book/src/prefix.md create mode 100644 test_book/src/rust/README.md create mode 100644 test_book/src/suffix.md diff --git a/.gitignore b/.gitignore index 36614264..a23c771e 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ guide/book .vscode tests/dummy_book/book/ +test_book/book/ # Ignore Jetbrains specific files. .idea/ diff --git a/test_book/book.toml b/test_book/book.toml new file mode 100644 index 00000000..a3050076 --- /dev/null +++ b/test_book/book.toml @@ -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" diff --git a/test_book/src/README.md b/test_book/src/README.md new file mode 100644 index 00000000..04d5afdc --- /dev/null +++ b/test_book/src/README.md @@ -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. diff --git a/test_book/src/SUMMARY.md b/test_book/src/SUMMARY.md new file mode 100644 index 00000000..88a4d396 --- /dev/null +++ b/test_book/src/SUMMARY.md @@ -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) diff --git a/test_book/src/individual/README.md b/test_book/src/individual/README.md new file mode 100644 index 00000000..dcec5fb7 --- /dev/null +++ b/test_book/src/individual/README.md @@ -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 diff --git a/test_book/src/languages/README.md b/test_book/src/languages/README.md new file mode 100644 index 00000000..373fbb9f --- /dev/null +++ b/test_book/src/languages/README.md @@ -0,0 +1 @@ +# Syntax Highlighting diff --git a/test_book/src/prefix.md b/test_book/src/prefix.md new file mode 100644 index 00000000..1c40c2cb --- /dev/null +++ b/test_book/src/prefix.md @@ -0,0 +1,3 @@ +# Prefix Chapter + +This is to verify the placement and style of prefix chapter in book index. diff --git a/test_book/src/rust/README.md b/test_book/src/rust/README.md new file mode 100644 index 00000000..e3bb350f --- /dev/null +++ b/test_book/src/rust/README.md @@ -0,0 +1 @@ +# Rust specific code examples diff --git a/test_book/src/suffix.md b/test_book/src/suffix.md new file mode 100644 index 00000000..9d86853c --- /dev/null +++ b/test_book/src/suffix.md @@ -0,0 +1,3 @@ +# Suffix Chapter + +This is to verify the placement and style of suffix chapter in book index.