Routing Rules

mkpages preserves structure relative to the chosen content root.

Core rules

• index.md maps to the containing directory
• README.md maps to the containing directory when index.md is absent
• any other name.md maps to name/
• nested structure is preserved relative to the content root

Examples

If the command is:

mkpages .

then:

• index.md becomes /
• docs/index.md becomes /docs/
• blog/post-1.md becomes /blog/post-1/

If the command is:

mkpages docs/

then:

• docs/index.md becomes /
• docs/getting-started.md becomes /getting-started/
• docs/examples/default.md becomes /examples/default/

Link rewriting

Relative Markdown links such as CLI Reference are rewritten so they continue to work after route generation.