Skip to content

Commit 1af6c0e

Browse files
committed
fix: update call out on page titles
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
1 parent 9650eff commit 1af6c0e

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/authoring/markdown.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,15 @@ explicitly defined page title, followed by a title derived from the first level
8989
one Markdown header. If none of these are available, the filename is used as a
9090
fallback.
9191

92-
!!! info "Future developments"
93-
Note that the order of priority defined above ensures compatibility with
94-
MkDocs. We are reviewing the handling of page titles in the context of our
95-
[work on navigation within Zensical Spark].
92+
!!! warning "Temporary limitation"
9693

97-
In particular, we are looking to preserve markup in the title, which MkDocs
98-
strips out, making workarounds necessary in the typeset plugin of Material
99-
for MkDocs to re-create a title that preserves markup.
94+
The order above applies to page titles in navigation.
10095

101-
Any re-design will include migration paths that avoid costly re-work.
96+
There's one case where Zensical currently does not behave exactly like MkDocs: if you specify a `nav` setting in configuration, but don't specify `# Page title` in your Markdown files, MkDocs will use the navigation title, whereas Zensical will use the base name of the Markdown file as the `h1` of the page.
10297

103-
[work on navigation within Zensical Spark]: https://zensical.org/about/roadmap/#modular-navigation
98+
---
99+
100+
We're currently redesigning navigation, and will address this issue as part of that work. [ZAP 001] outlines behavior of page titles and their use cases. In particular, we are looking to preserve markup in the title, which MkDocs
101+
strips out. Any re-design will include migration paths that avoid costly re-work.
102+
103+
[ZAP 001]: https://zensical.org/spark/proposals/zap-001-page-titles/

0 commit comments

Comments
 (0)