From 2674347768416a7ea3dc9b9af59b6a6c52184eb7 Mon Sep 17 00:00:00 2001 From: Fabien Tregan Date: Mon, 10 Aug 2020 10:52:22 +0200 Subject: [PATCH] Adds information about markdown flavor in the documentation. --- book-example/src/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book-example/src/README.md b/book-example/src/README.md index f434c1e9..99e55bce 100644 --- a/book-example/src/README.md +++ b/book-example/src/README.md @@ -1,8 +1,8 @@ # mdBook **mdBook** is a command line tool and Rust crate to create books using Markdown -files. It's very similar to Gitbook but written in -[Rust](http://www.rust-lang.org). +(as by the [CommonMark](https://commonmark.org/) specification) files. It's very +similar to Gitbook but written in [Rust](http://www.rust-lang.org). What you are reading serves as an example of the output of mdBook and at the same time as a high-level documentation.