rust-lang / rust-lang/mdBook

Docs missing Homebrew install

Open
#2,434 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
Avg merge
2d 21h
Merged PRs (30d)
12

Description

Problem

Probably the easiest way to install mdbook on Mac is Homebrew. But I didn't see any mention of that on the install page.

Proposed Solution

Add a line about installing via Homebrew. Happy to do the pr myself if that's needed.

Notes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating mdBook's installation page in the documentation and review its existing package-installation guidance. Add a line describing installation through Homebrew using the linked mdBook formula, then verify the page clearly includes this option.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.