Rust Feed

Rust Feed is an open-source collection of Rust articles and tutorials originally posted in the Facebook Rust Dev Community. This repository serves as a centralized, well-organized knowledge base built with mdBook.

Access the Book

You can read the compiled book online here: Rust Feed Documentation

---

Prerequisites

To run this project locally and build the documentation, you will need:

• Rust and Cargo: Install via rustup (curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh)

• mdBook: Install via cargo:

  cargo install mdbook

---

How to Contribute / Add New Articles

We have fully automated the indexing process native to the Rust ecosystem. To add a new article to the book:

1. Create your Markdown file: Write your article and save it as a .md file. Ensure it has a # Heading 1 at the top as the title.

2. Place it in the correct category: Move your .md file into the corresponding category folder inside src/. For example:

   src/case-study/my-new-article.md
   

3. Run the Update Script: From the root of the project, run the update script. This script will automatically update the category index and regenerate the SUMMARY.md file using our custom Rust auto-indexer.

   ./update.sh

4. Preview locally (Optional):

   mdbook serve --open

---

Project Structure

rust-feed/
├── book/                  # Compiled HTML output (gitignored)
├── scripts/
│   └── auto_index/        # Custom Rust CLI to auto-generate indices and SUMMARY.md
├── src/                   # Markdown source files for the book
│   ├── case-study/        # Category folders containing articles
│   ├── deep-dive/
│   ├── ...
│   ├── README.md          # Introduction page for mdBook
│   └── SUMMARY.md         # Auto-generated book sidebar structure
├── book.toml              # mdBook configuration
├── update.sh              # Wrapper script to run auto_index and mdbook build
└── README.md              # This file

---

License

This project is licensed under the MIT License.