rust-lang / rust-lang/mdBook

Exclude page from printing

Open
#2,402 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
PR merge metrics
PR metrics pending

Description

Problem

I also keep the changelog in my mdBook and I find it unnecessary to print it out.

Proposed Solution

An option that allows you to exclude certain directories or files when printing.

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 code path for printing and how it selects source directories and files. Define how an exclusion option should identify paths, then verify that configured changelog files or directories are omitted from printed output while the remaining book content is unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.