Update documentation to include `print.md` and `print.html`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
"
When the html pages are generated a file called print.html is also generated. When the user clicks on the printer icon mdbook will use this file to show the content that will be printed.
If the user creates a file called src/print.md and references it from the SUMMARY.md the rendering of HTML pages will fail with the following error message: print.md is reserved for internal use.
"
Mentioning both print.md and print.html in the documentation will allow users to search for them and will help the users to understand the behavior.
See also the discussion in #3047
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the documentation and the discussion in #3047 for the existing explanation of generated print pages and reserved filenames. Update it to mention both print.md and print.html, including that print.md cannot be used as a source file; done when users can find and understand this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100