Rust Documentation

Open-source Rust projects categorized as Documentation

Top 12 Rust Documentation Projects

Documentation
  1. utoipa

    Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust

  2. SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
  3. bevy-cheatbook

    Unofficial Reference Book for the Bevy Game Engine

    Project mention: The Bevy Foundation | news.ycombinator.com | 2024-03-12

    I've been using Bevy recently so here are some thoughts on this:

    Firstly, the overall quality is high and seeing this attention being paid to the project's organization is another good sign.

    Documentation is not great great. The Bevy book runs out of content very quickly. The "Cheat Book" has additional useful information: https://bevy-cheatbook.github.io/. With these plus the examples I've been able to figure out everything I need, but it's slow going.

    I'm not 100% sold on ECS. It loses a lot of type safety and there doesn't seem to be any way to ensure cleanup of entities and their components.

  4. reference

    The Rust Reference (by rust-lang)

  5. vim-doge

    (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥

  6. doctave

    A batteries-included developer documentation site generator

  7. rust-library-i18n

    Rust 核心库和标准库中文翻译,可作为 IDE 工具的智能提示,并生成本地 API 文档

  8. deno_doc

    Documentation generator for Deno

    Project mention: Publish pure ESM npm package written in TypeScript to JSR | dev.to | 2024-05-12

    JSR uses Deno's document generator (deno_doc), which is under development and doesn't support all JSDoc tags yet3. So your JSDoc comment can be showed differently from your intention. You can run deno doc --unstable-sloppy-imports --html path/to/entrypoint.ts to check how generate docs will look.

  9. fundoc

    Fundoc - the right way to generate documentation

  10. doku

    fn(Code) -> Docs (by anixe)

  11. mdbook-plantuml

    mdBook preprocessor to render PlantUML diagrams to png images in the book output directory

  12. sideko

    Generate SDKs and docs for your API

  13. caniuse-rs

    A command line client and Alfred workflow for caniuse.com, written in Rust 🦀

NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

Rust Documentation discussion

Log in or Post with

Rust Documentation related posts

  • Everything Curl

    3 projects | news.ycombinator.com | 29 Apr 2024
  • Doks – Build a Docs Site

    2 projects | news.ycombinator.com | 5 Mar 2024
  • TSDocs.dev: type docs for any JavaScript library

    6 projects | news.ycombinator.com | 19 Dec 2023
  • Display glitch with Chromium based browsers (Chrome, Edge, and Brave)

    2 projects | /r/pop_os | 11 Jul 2023
  • MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust

    30 projects | news.ycombinator.com | 29 Jun 2023
  • Why is there no standard way of removing the mutability property from a reference?

    1 project | /r/rust | 21 Jun 2023
  • Polkadot Forum - Advanced Level Discussion

    3 projects | /r/polkadot_market | 3 Jun 2023
  • A note from our sponsor - SaaSHub
    www.saashub.com | 23 Jan 2025
    SaaSHub helps you find the best software and product alternatives Learn more →

Index

What are some of the best open-source Documentation projects in Rust? This list will help you:

# Project Stars
1 utoipa 2,728
2 bevy-cheatbook 1,997
3 reference 1,288
4 vim-doge 1,011
5 doctave 568
6 rust-library-i18n 535
7 deno_doc 273
8 fundoc 163
9 doku 80
10 mdbook-plantuml 79
11 sideko 61
12 caniuse-rs 5

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com

Did you know that Rust is
the 5th most popular programming language
based on number of references?