Allow pages to override their navigational header

Author: Mpdreamz

docs/source/elastic/semantic-search/amazon-bedrock.md

@@ -1,5 +1,6 @@
 ---
 title: "Semantic search with the inference API"
+navigation_title: "Amazon Bedrock"
 ---
 
 Semantic search helps you find data based on the intent and contextual meaning of a search query, instead of a match on query terms (lexical search).

docs/source/elastic/semantic-search/azure-ai-studio.md

@@ -1,5 +1,6 @@
 ---
 title: "Semantic search with the inference API"
+navigation_title: "Azure AI Studio"
 ---
 
 Semantic search helps you find data based on the intent and contextual meaning of a search query, instead of a match on query terms (lexical search).

docs/source/elastic/semantic-search/azure-openai.md

@@ -1,5 +1,6 @@
 ---
 title: "Semantic search with the inference API"
+navigation_title: "Azure OpenAI"
 ---
 
 Semantic search helps you find data based on the intent and contextual meaning of a search query, instead of a match on query terms (lexical search).

docs/source/elastic/semantic-search/cohere.md

@@ -1,5 +1,6 @@
 ---
 title: "Semantic search with the inference API"
+navigation_title: "Cohere"
 ---
 
 Semantic search helps you find data based on the intent and contextual meaning of a search query, instead of a match on query terms (lexical search).

docs/source/elastic/semantic-search/elser.md

@@ -1,5 +1,6 @@
 ---
 title: "Semantic search with the inference API"
+navigation_title: "ELSER"
 ---
 
 Semantic search helps you find data based on the intent and contextual meaning of a search query, instead of a match on query terms (lexical search).

src/Elastic.Markdown/IO/MarkdownFile.cs

@@ -16,7 +16,7 @@ namespace Elastic.Markdown.IO;
 public class MarkdownFile : DocumentationFile
 {
 	private readonly SlugHelper _slugHelper = new();
-	private string? _tocTitle;
+	private string? _navigationTitle;
 
 	public MarkdownFile(IFileInfo sourceFile, IDirectoryInfo rootPath, MarkdownParser parser, BuildContext context)
 		: base(sourceFile, rootPath)
@@ -32,10 +32,10 @@ public MarkdownFile(IFileInfo sourceFile, IDirectoryInfo rootPath, MarkdownParse
 	private FrontMatterParser FrontMatterParser { get; } = new();
 	public YamlFrontMatter? YamlFrontMatter { get; private set; }
 	public string? Title { get; private set; }
-	public string? TocTitle
+	public string? NavigationTitle
 	{
-		get => !string.IsNullOrEmpty(_tocTitle) ? _tocTitle : Title;
-		set => _tocTitle = value;
+		get => !string.IsNullOrEmpty(_navigationTitle) ? _navigationTitle : Title;
+		private set => _navigationTitle = value;
 	}
 
 	public List<PageTocItem> TableOfContents { get; } = new();
@@ -53,6 +53,7 @@ public async Task<MarkdownDocument> ParseFullAsync(Cancel ctx)
 			var raw = string.Join(Environment.NewLine, yaml.Lines.Lines);
 			YamlFrontMatter = FrontMatterParser.Deserialize(raw);
 			Title = YamlFrontMatter.Title;
+			NavigationTitle = YamlFrontMatter.NavigationTitle;
 		}
 
 		var contents = document

src/Elastic.Markdown/Myst/FrontMatterParser.cs

@@ -12,7 +12,12 @@ public partial class YamlFrontMatterStaticContext;
 [YamlSerializable]
 public class YamlFrontMatter
 {
+	[YamlMember(Alias = "title")]
 	public string? Title { get; set; }
+
+	[YamlMember(Alias = "navigation_title")]
+	public string? NavigationTitle { get; set; }
+
 	[YamlMember(Alias = "sub")]
 	public Dictionary<string, string>? Properties { get; set; }
 }
@@ -25,7 +30,6 @@ public YamlFrontMatter Deserialize(string yaml)
 
 		var deserializer = new StaticDeserializerBuilder(new YamlFrontMatterStaticContext())
 			.IgnoreUnmatchedProperties()
-			.WithNamingConvention(CamelCaseNamingConvention.Instance)
 			.Build();
 
 		var frontMatter = deserializer.Deserialize<YamlFrontMatter>(input);

src/Elastic.Markdown/Slices/Layout/_TocTreeNav.cshtml

@@ -2,13 +2,13 @@
 @foreach (var file in Model.SubTree.FilesInOrder)
 {
 	var current = file == Model.CurrentDocument ? " current" : string.Empty;
-<li class="toctree-l@(Model.SubTree.Level + 1)@current"><a class="@(current.Trim()) reference internal" href="@file.Url">@file.TocTitle</a></li>
+<li class="toctree-l@(Model.SubTree.Level + 1)@current"><a class="@(current.Trim()) reference internal" href="@file.Url">@file.NavigationTitle</a></li>
 }
 @foreach (var g in Model.SubTree.GroupsInOrder)
 {
 	var current = g.HoldsCurrent(Model.CurrentDocument) ? " current" : string.Empty;
 	var currentFile = g.Index == Model.CurrentDocument ? " current" : string.Empty;
-<li class="toctree-l@(g.Level)@current"><a class="reference internal@(currentFile)" href="@g.Index?.Url">@g.Index?.TocTitle</a>@if (@g.FilesInOrder.Count > 0 || g.GroupsInOrder.Count > 0) {<ul class="@(current.Trim())">@await RenderPartialAsync(Elastic.Markdown.Slices.Layout._TocTreeNav.Create(new NavigationTreeItem
+<li class="toctree-l@(g.Level)@current"><a class="reference internal@(currentFile)" href="@g.Index?.Url">@g.Index?.NavigationTitle</a>@if (@g.FilesInOrder.Count > 0 || g.GroupsInOrder.Count > 0) {<ul class="@(current.Trim())">@await RenderPartialAsync(Elastic.Markdown.Slices.Layout._TocTreeNav.Create(new NavigationTreeItem
 		{
 			Level = g.Level,
 			CurrentDocument = Model.CurrentDocument,

tests/Elastic.Markdown.Tests/Directives/YamlFrontMatterTests.cs

@@ -10,10 +10,25 @@ public class YamlFrontMatterTests(ITestOutputHelper output) : DirectiveTest(outp
 """
 ---
 title: Elastic Docs v3
+navigation_title: "Documentation Guide"
+sub:
+  key: "value"
 ---
 """
 )
 {
 	[Fact]
-	public void Test1() => File.Title.Should().Be("Elastic Docs v3");
+	public void ReadsTitle() => File.Title.Should().Be("Elastic Docs v3");
+
+	[Fact]
+	public void ReadsNavigationTitle() => File.NavigationTitle.Should().Be("Documentation Guide");
+
+	[Fact]
+	public void ReadsSubstitutions()
+	{
+		File.YamlFrontMatter.Should().NotBeNull();
+		File.YamlFrontMatter!.Properties.Should().NotBeEmpty()
+			.And.HaveCount(1)
+			.And.ContainKey("key");
+	}
 }