It is recommended that all md files in the directory be converted to html

Open
#830 6 comments 20 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start by tracing how mdBook selects Markdown files from SUMMARY.md and how links such as Link to xxx are handled. The work is done when Markdown files outside SUMMARY.md are also converted to HTML and their internal links resolve correctly.

Written by the indexing model from the issue text.

Description

A-Summary

It is recommended that all md files in the directory be converted to html instead of just the ones that appear in SUMMARY.md, so that the internal links will work as you would see in github.

As now, if my readme.md has this content:

[Link to xxx](xxx.md)

This only work when xxx.md is placed in SUMMARY.md

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

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.

More from rust-lang/mdBook

All issues in rust-lang/mdBook

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.