rust-lang/mdBookNew scan
76/ 100 · C

Popular and well-maintained. A little polish away from elite status.

Create book from markdown files. Like Gitbook but implemented in Rust

Rust21,791 starsMPL-2.0updated 8d ago
DocumentationREADME, setup, examples, license
85
EngineeringTests, CI, linting, lockfiles
69
Project healthDescription, activity, stars, deps
78

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Tests
    EngineeringWarning

    Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Detailed breakdown

Documentation

85
  • README68
    • README is present.
    • README is fairly short (worth +10 pts; 1,500+ characters earns the full +20 pts).Expand with a description, install steps, usage, and examples.
    • README has some structure (+8 pts); 4+ sections earns the full +15 pts.Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MPL-2.0.
  • Contributing guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

69
  • Tests35
    • Test files detected (tests).
    • The npm test script is the default placeholder. Running `npm test` will fail.Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/main.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (eslint.config.mjs).
    • Lint script wired into package.json.
  • Reproducibility70
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

78
  • Dependency manifest55
    • Dependency manifest found (Cargo.toml).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • package.json has no repository field (−10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
    • package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
    • package.json has no build script (−10 pts).Add a `build` script to package.json so the project can be compiled with `npm run build`.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 21,791 stars.
  • Housekeeping100
    • .gitignore present.
Repository files22 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Issue or PR templates present.
  • ci
  • crates
  • examples
  • guide
  • src
  • tests
    Good: Test files detected (tests).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • LICENSE
    Good: Licensed under MPL-2.0.
  • package.json
  • README.md
    Good: README is present.
    Info: README is fairly short (worth +10 pts; 1,500+ characters earns the full +20 pts).Fix: Expand with a description, install steps, usage, and examples.
    Info: README has some structure (+8 pts); 4+ sections earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rustfmt.toml
  • triagebot.toml