Introduction to Markdown and mdBook
Welcome to your documentation site! This site is built using:
- Markdown: a lightweight markup language for formatting plaintext.
- mdBook: a static site generator for Markdown files, created by Rust.
In this repository, you'll see these files:
src/
├── README.md
├── SUMMARY.md
└── chapter-1.md
README.md
: This file is the introduction to your book.SUMMARY.md
: This file lists all the chapters in your books. You can have sub-chapters using sub-bullets.chapter-1.md
: This is an example Markdown file.
Examples
Looking for inspiration of other documentation sites built using mdBook? Try these (not affiliated):
-
The Rust Reference: An informal handbook describing the syntax, language constructs, and idioms of the Rust programming language.
-
The Rust Programming Guide: A detailed guide to learning how to write Rust code.
-
Rust by Example: A guide of learning how to write Rust, using examples.
-
Learn Rust With Entirely Too Many Linked Lists: A different approach to learning Rust and it's memory-safety using a data structure known as a linked list.
-
Rust and WebAssembly: A guide on how to write Rust code for the WebAssembly runtime.
-
Amethyst: A game engine written in Rust, developed by the Amethyst team and open-source community.
-
Void Linux Handbook: A guide on how to use the Void Linux operating system.