Skip to content

fix 183 prevent index pages from being listed twice #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2025
Merged

fix 183 prevent index pages from being listed twice #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/Elastic.Markdown/IO/Navigation/DocumentationGroup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,11 @@ public DocumentationGroup(
)
{
Depth = depth;
var foundIndex = ProcessTocItems(toc, lookup, folderLookup, depth, out var groups, out var files, out var navigationItems);
Index = ProcessTocItems(index, toc, lookup, folderLookup, depth, out var groups, out var files, out var navigationItems);

GroupsInOrder = groups;
FilesInOrder = files;
NavigationItems = navigationItems;
Index = index ?? foundIndex;

if (Index is not null)
FilesInOrder = FilesInOrder.Except([Index]).ToList();
Expand All @@ -55,19 +54,19 @@ public DocumentationGroup(
}

private MarkdownFile? ProcessTocItems(
MarkdownFile? configuredIndex,
IReadOnlyCollection<ITocItem> toc,
IDictionary<string, DocumentationFile> lookup,
IDictionary<string, DocumentationFile[]> folderLookup,
int depth,
out List<DocumentationGroup> groups,
out List<MarkdownFile> files,
out List<INavigationItem> navigationItems
)
out List<INavigationItem> navigationItems)
{
groups = [];
navigationItems = [];
files = [];
MarkdownFile? indexFile = null;
var indexFile = configuredIndex;
foreach (var (tocItem, index) in toc.Select((t, i) => (t, i)))
{
if (tocItem is FileReference file)
Expand All @@ -89,9 +88,14 @@ out List<INavigationItem> navigationItems
}

files.Add(md);
navigationItems.Add(new FileNavigation(index, depth, md));
if (file.Path.EndsWith("index.md") && d is MarkdownFile i)
indexFile ??= i;

// add the page to navigation items unless it's the index file
// the index file can either be the discovered `index.md` or the parent group's
// explicit index page. E.g. when grouping related files together.
if (indexFile != md)
navigationItems.Add(new FileNavigation(index, depth, md));
}
else if (tocItem is FolderReference folder)
{
Expand Down
Loading