Reorganize Elastic.Markdown so that code is grouped by purpose not type

Author: Mpdreamz

src/Elastic.Markdown/Slices/DescriptionGenerator.cs renamed to src/Elastic.Markdown/DescriptionGenerator.cs

@@ -7,7 +7,7 @@
 using Markdig.Syntax;
 using Markdig.Syntax.Inlines;
 
-namespace Elastic.Markdown.Slices;
+namespace Elastic.Markdown;
 
 public interface IDescriptionGenerator
 {

src/Elastic.Markdown/DocumentationGenerator.cs

@@ -15,7 +15,6 @@
 using Elastic.Markdown.Exporters;
 using Elastic.Markdown.IO;
 using Elastic.Markdown.Links.CrossLinks;
-using Elastic.Markdown.Slices;
 using Markdig.Syntax;
 using Microsoft.Extensions.Logging;
 

src/Elastic.Markdown/Exporters/DocumentationFileExporter.cs

@@ -5,7 +5,6 @@
 using System.IO.Abstractions;
 using Elastic.Documentation.Configuration;
 using Elastic.Markdown.IO;
-using Elastic.Markdown.Slices;
 using Markdig.Syntax;
 
 namespace Elastic.Markdown.Exporters;

src/Elastic.Markdown/Slices/HtmlWriter.cs renamed to src/Elastic.Markdown/HtmlWriter.cs

@@ -10,11 +10,12 @@
 using Elastic.Documentation.Site.Navigation;
 using Elastic.Markdown.Extensions.DetectionRules;
 using Elastic.Markdown.IO;
+using Elastic.Markdown.Page;
 using Markdig.Syntax;
 using RazorSlices;
 using IFileInfo = System.IO.Abstractions.IFileInfo;
 
-namespace Elastic.Markdown.Slices;
+namespace Elastic.Markdown;
 
 public class HtmlWriter(
 	DocumentationSet documentationSet,
@@ -99,7 +100,7 @@ private async Task<string> RenderLayout(MarkdownFile markdown, MarkdownDocument
 		if (PositionalNavigation.MarkdownNavigationLookup.TryGetValue("docs-content://versions.md", out var item))
 			allVersionsUrl = item.Url;
 
-		var slice = Index.Create(new IndexViewModel
+		var slice = Page.Index.Create(new IndexViewModel
 		{
 			SiteName = siteName,
 			DocSetName = DocumentationSet.Name,

src/Elastic.Markdown/IO/DocumentationFile.cs

@@ -5,7 +5,6 @@
 using Elastic.Documentation.Site;
 using Elastic.Markdown.Myst;
 using Elastic.Markdown.Myst.FrontMatter;
-using Elastic.Markdown.Slices;
 
 namespace Elastic.Markdown.IO;
 

src/Elastic.Markdown/IO/MarkdownFile.cs

@@ -13,9 +13,9 @@
 using Elastic.Markdown.Links.CrossLinks;
 using Elastic.Markdown.Myst;
 using Elastic.Markdown.Myst.Directives;
+using Elastic.Markdown.Myst.Directives.Include;
 using Elastic.Markdown.Myst.FrontMatter;
 using Elastic.Markdown.Myst.InlineParsers;
-using Elastic.Markdown.Slices;
 using Markdig;
 using Markdig.Extensions.Yaml;
 using Markdig.Renderers.Roundtrip;

src/Elastic.Markdown/IO/Navigation/DocumentationGroup.cs

@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information
 
 using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration;
 using Elastic.Documentation.Configuration.TableOfContents;
@@ -12,84 +11,6 @@
 
 namespace Elastic.Markdown.IO.Navigation;
 
-[DebuggerDisplay("Current: {Model.RelativePath}")]
-public record FileNavigationItem(MarkdownFile Model, DocumentationGroup Group, bool Hidden = false) : ILeafNavigationItem<MarkdownFile>
-{
-	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; } = Group;
-	public IRootNavigationItem<INavigationModel, INavigationItem> NavigationRoot { get; } = Group.NavigationRoot;
-	public string Url => Model.Url;
-	public string NavigationTitle => Model.NavigationTitle;
-	public int NavigationIndex { get; set; }
-}
-
-public class TableOfContentsTreeCollector
-{
-	private Dictionary<Uri, TableOfContentsTree> NestedTableOfContentsTrees { get; } = [];
-
-	public void Collect(Uri source, TableOfContentsTree tree) =>
-		NestedTableOfContentsTrees[source] = tree;
-
-	public void Collect(TocReference tocReference, TableOfContentsTree tree) =>
-		NestedTableOfContentsTrees[tocReference.Source] = tree;
-
-	public bool TryGetTableOfContentsTree(Uri source, [NotNullWhen(true)] out TableOfContentsTree? tree) =>
-		NestedTableOfContentsTrees.TryGetValue(source, out tree);
-}
-
-
-[DebuggerDisplay("Toc >{Depth} {FolderName} ({NavigationItems.Count} items)")]
-public class TableOfContentsTree : DocumentationGroup, IRootNavigationItem<MarkdownFile, INavigationItem>
-{
-	public Uri Source { get; }
-
-	public TableOfContentsTreeCollector TreeCollector { get; }
-
-	public TableOfContentsTree(
-		Uri source,
-		BuildContext context,
-		NavigationLookups lookups,
-		TableOfContentsTreeCollector treeCollector,
-		ref int fileIndex)
-		: base(".", treeCollector, context, lookups, source, ref fileIndex, 0, null, null)
-	{
-		TreeCollector = treeCollector;
-		NavigationRoot = this;
-
-		Source = source;
-		TreeCollector.Collect(source, this);
-
-		//edge case if a tree only holds a single group, ensure we collapse it down to the root (this)
-		if (NavigationItems.Count == 1 && NavigationItems.First() is DocumentationGroup { NavigationItems.Count: 0 })
-			NavigationItems = [];
-
-
-	}
-
-	internal TableOfContentsTree(
-		Uri source,
-		string folderName,
-		TableOfContentsTreeCollector treeCollector,
-		BuildContext context,
-		NavigationLookups lookups,
-		ref int fileIndex,
-		int depth,
-		IRootNavigationItem<MarkdownFile, INavigationItem> toplevelTree,
-		DocumentationGroup? parent
-	) : base(folderName, treeCollector, context, lookups, source, ref fileIndex, depth, toplevelTree, parent)
-	{
-		Source = source;
-		TreeCollector = treeCollector;
-		NavigationRoot = this;
-		TreeCollector.Collect(source, this);
-	}
-
-	protected override IRootNavigationItem<MarkdownFile, INavigationItem> DefaultNavigation => this;
-
-	// We rely on IsPrimaryNavEnabled to determine if we should show the dropdown
-	/// <inheritdoc />
-	public bool IsUsingNavigationDropdown => false;
-}
-
 [DebuggerDisplay("Group >{Depth} {FolderName} ({NavigationItems.Count} items)")]
 public class DocumentationGroup : INodeNavigationItem<MarkdownFile, INavigationItem>
 {

src/Elastic.Markdown/IO/Navigation/FileNavigationItem.cs

@@ -0,0 +1,18 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Diagnostics;
+using Elastic.Documentation.Site.Navigation;
+
+namespace Elastic.Markdown.IO.Navigation;
+
+[DebuggerDisplay("Current: {Model.RelativePath}")]
+public record FileNavigationItem(MarkdownFile Model, DocumentationGroup Group, bool Hidden = false) : ILeafNavigationItem<MarkdownFile>
+{
+	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; } = Group;
+	public IRootNavigationItem<INavigationModel, INavigationItem> NavigationRoot { get; } = Group.NavigationRoot;
+	public string Url => Model.Url;
+	public string NavigationTitle => Model.NavigationTitle;
+	public int NavigationIndex { get; set; }
+}

src/Elastic.Markdown/IO/Navigation/TableOfContentsTree.cs

@@ -0,0 +1,62 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Diagnostics;
+using Elastic.Documentation.Configuration;
+using Elastic.Documentation.Site.Navigation;
+
+namespace Elastic.Markdown.IO.Navigation;
+
+[DebuggerDisplay("Toc >{Depth} {FolderName} ({NavigationItems.Count} items)")]
+public class TableOfContentsTree : DocumentationGroup, IRootNavigationItem<MarkdownFile, INavigationItem>
+{
+	public Uri Source { get; }
+
+	public TableOfContentsTreeCollector TreeCollector { get; }
+
+	public TableOfContentsTree(
+		Uri source,
+		BuildContext context,
+		NavigationLookups lookups,
+		TableOfContentsTreeCollector treeCollector,
+		ref int fileIndex)
+		: base(".", treeCollector, context, lookups, source, ref fileIndex, 0, null, null)
+	{
+		TreeCollector = treeCollector;
+		NavigationRoot = this;
+
+		Source = source;
+		TreeCollector.Collect(source, this);
+
+		//edge case if a tree only holds a single group, ensure we collapse it down to the root (this)
+		if (NavigationItems.Count == 1 && NavigationItems.First() is DocumentationGroup { NavigationItems.Count: 0 })
+			NavigationItems = [];
+
+
+	}
+
+	internal TableOfContentsTree(
+		Uri source,
+		string folderName,
+		TableOfContentsTreeCollector treeCollector,
+		BuildContext context,
+		NavigationLookups lookups,
+		ref int fileIndex,
+		int depth,
+		IRootNavigationItem<MarkdownFile, INavigationItem> toplevelTree,
+		DocumentationGroup? parent
+	) : base(folderName, treeCollector, context, lookups, source, ref fileIndex, depth, toplevelTree, parent)
+	{
+		Source = source;
+		TreeCollector = treeCollector;
+		NavigationRoot = this;
+		TreeCollector.Collect(source, this);
+	}
+
+	protected override IRootNavigationItem<MarkdownFile, INavigationItem> DefaultNavigation => this;
+
+	// We rely on IsPrimaryNavEnabled to determine if we should show the dropdown
+	/// <inheritdoc />
+	public bool IsUsingNavigationDropdown => false;
+}

src/Elastic.Markdown/IO/Navigation/TableOfContentsTreeCollector.cs

@@ -0,0 +1,22 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Diagnostics.CodeAnalysis;
+using Elastic.Documentation.Configuration.TableOfContents;
+
+namespace Elastic.Markdown.IO.Navigation;
+
+public class TableOfContentsTreeCollector
+{
+	private Dictionary<Uri, TableOfContentsTree> NestedTableOfContentsTrees { get; } = [];
+
+	public void Collect(Uri source, TableOfContentsTree tree) =>
+		NestedTableOfContentsTrees[source] = tree;
+
+	public void Collect(TocReference tocReference, TableOfContentsTree tree) =>
+		NestedTableOfContentsTrees[tocReference.Source] = tree;
+
+	public bool TryGetTableOfContentsTree(Uri source, [NotNullWhen(true)] out TableOfContentsTree? tree) =>
+		NestedTableOfContentsTrees.TryGetValue(source, out tree);
+}