mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 18:08:31 +07:00

Files

Oleh Prypin 5af8bd3053 Infer titles of pages based on full Markdown parsing (#3191 )

Properly parse Markdown and report the first H1 tag rather than naively looking for `# Stuff` at the start of the doc.

This satisfies feature requests such as supporting setext-style headers and fixes attr-list suffixes that failed to be ignored.

Co-authored-by: Hendrik Polczynski <hendrikpolczyn@gmail.com>
Co-authored-by: Darrick Herwehe <darrick@exitcodeone.com>

2023-05-29 21:59:31 +02:00

choosing-your-theme.md

Link to Best-of-MkDocs instead of Plugins wiki in docs (#3207 )

2023-05-02 22:42:16 +02:00

cli.md

Add CLI reference page, auto-generated from Click (#2996 )

2022-10-08 11:17:05 +02:00

configuration.md

Link to Best-of-MkDocs instead of Plugins wiki in docs (#3207 )

2023-05-02 22:42:16 +02:00

customizing-your-theme.md

Update customizing-your-theme.md (#3215 )

2023-05-07 10:20:05 +02:00

deploying-your-docs.md

Docs: add warning about uncommitted changes (#3034 )

2022-11-07 00:57:33 +01:00

installation.md

Replace instances of ```no-highlight

2022-09-19 22:22:33 +02:00

localizing-your-theme.md

Migrate docs from "admonition" to "callouts" extension (#2684 )

2022-08-06 17:35:36 +02:00

README.md

Add CLI reference page, auto-generated from Click (#2996 )

2022-10-08 11:17:05 +02:00

writing-your-docs.md

Infer titles of pages based on full Markdown parsing (#3191 )

2023-05-29 21:59:31 +02:00

README.md

User Guide

Building Documentation with MkDocs

The MkDocs Developer Guide provides documentation for users of MkDocs. See Getting Started for an introductory tutorial. You can jump directly to a page listed below, or use the next and previous buttons in the navigation bar at the top of the page to move through the documentation in order.