Rust Documentation

Open-source Rust projects categorized as Documentation
Edit details
Topics: Rust documentation-generator CLI rust-lang Book
Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com
featured

Top 13 Rust Documentation Projects

  • utoipa

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

    • Project mention: What's everyone working on this week (23/2023)? | /r/rust | 2023-06-05

    In case you didn't know https://github.com/juhaku/utoipa is really nice to generate openapi spec and have a swagger!

  • 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.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo

  • reference

    The Rust Reference (by rust-lang)

    • Project mention: Why is there no standard way of removing the mutability property from a reference? | /r/rust | 2023-06-21

    Is perfectly valid Rust code. And there's reborrow, too.

  • vim-doge

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

    • Project mention: vim-doge v4: The Rust Rewrite | /r/rust | 2023-07-10

    I’m the creator of the vim plugin called vim-doge and I like to share some awesome benchmark results with the new version that has been written in Rust.

  • pandocs

    The single, most comprehensive Game Boy technical reference.

    • Project mention: Gameboy Technical Reference for Homebrew Developers | news.ycombinator.com | 2023-11-23

  • rust-library-i18n

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

  • doctave

    A batteries-included developer documentation site generator

  • SaaSHub

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

    SaaSHub logo

  • 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.

  • fundoc

    Fundoc - the right way to generate documentation

  • doku

    fn(Code) -> Docs (by anixe)

    • Project mention: Hey Rustaceans! Got a question? Ask here (26/2023)! | /r/rust | 2023-06-26

    If I can choose a project of mine, I'd say that https://github.com/anixe/doku was very fun to write - and it was handy too as before it people at my team were writing docs by hand 👀 (where one of our services literally has 100+ endpoints)

  • mdbook-plantuml

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

    • Project mention: Documentation as Code for Cloud Using PlantUML | news.ycombinator.com | 2023-07-30

    I started using plantuml more rigorously at work. I've found that collaboration on the drawings/diagrams, is simpler and easier as it can be tracked in Git. One additional thing that I've been using as well is the mdBook plugin to embed and render the images as part of a larger book. This has been helpful for large systems when there are many teams involved.

    https://github.com/sytsereitsma/mdbook-plantuml

  • sideko

    Generate SDKs and docs for your API

    • Project mention: Show HN: Hacker News API SDKs → Code Generation in Rust | news.ycombinator.com | 2023-10-17

    Hi Hacker News!

    Patrick and Elias here. We built an SDK / Documentation generator for REST APIs. The link included shows the shiny output of our system: the docs! We generated 5 SDKs and docs from the Hacker News OpenAPI we found on GitHub. If you write code in Python, Typescript, Go, Ruby, or Rust, we’d love for you to try an SDK out!

    If you want to generate SDKs for your own API try our tool here: https://github.com/Sideko-Inc/sideko

    We are both software engineers, and we built this tool because we were spending too much time writing API integrations, supporting integrations, writing documentation, and manually testing APIs at our jobs. We think every engineer can benefit from spending less time on APIs.

    The generator is written in Rust because we need the rich type system, macros, and general correctness emphasis to generate working code. The SDKs are typed, they simplify auth, and they handle files.

    If you want to learn more, check out our complete write up here: https://sideko.substack.com/p/the-hacker-news-api-enhanced-b...

    Thanks everyone,

    PK and EP - [email protected]

  • 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 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 - InfluxDB
    www.influxdata.com | 3 Jun 2024
    Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality. Learn more →

Index

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

Project Stars
1 utoipa 1,930
2 bevy-cheatbook 1,708
3 reference 1,151
4 vim-doge 966
5 pandocs 573
6 rust-library-i18n 533
7 doctave 521
8 deno_doc 251
9 fundoc 163
10 doku 80
11 mdbook-plantuml 75
12 sideko 46
13 caniuse-rs 5

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