Problem
In normal circumstances mdbook will generate a file called toc.html that will contain the Table of Contents`. It is used as the TOC for people (and bots) who don't run JavaScript.
If the user creates a file called src/toc.md and references it in SUMMARY.md then mdbook will use it to generated the toc.html file replacing the normally generated one.
Proposed Solution
IMHO this should be avoided.
- If there is a an
toc.md file the build process should stop with an error toc.md is reserved for internal use.
- Regardless of 1. being implemented or not, the behaviour should be described in the documentation so people can search for either
toc.html , toc.md or toc and find it.
Notes
See also #3047
Problem
In normal circumstances mdbook will generate a file called
toc.htmlthat will contain the Table of Contents`. It is used as the TOC for people (and bots) who don't run JavaScript.If the user creates a file called
src/toc.mdand references it inSUMMARY.mdthen mdbook will use it to generated thetoc.htmlfile replacing the normally generated one.Proposed Solution
IMHO this should be avoided.
toc.mdfile the build process should stop with an errortoc.md is reserved for internal use.toc.html,toc.mdortocand find it.Notes
See also #3047