Configurable position of TOC

MaxMelcher · Nov 28, 2022 · ea7d524 · ea7d524
1 parent fdf05ad
commit ea7d524
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/AzureDevOps.WikiPDFExport/MarkdownConverter.cs b/AzureDevOps.WikiPDFExport/MarkdownConverter.cs
@@ -66,7 +66,9 @@ internal string ConvertToHTML(IList<MarkdownFile> files)
 
             if (!string.IsNullOrEmpty(_options.GlobalTOC))
             {
-                var firstMDFileInfo = files[0].FileInfo;
+                if (_options.GlobalTOCPosition > files.Count)
+                    _options.GlobalTOCPosition = files.Count;
+                var firstMDFileInfo = files[_options.GlobalTOCPosition].FileInfo;
                 var directoryName = firstMDFileInfo.Directory.Name;
                 var tocName = _options.GlobalTOC == "" ? directoryName : _options.GlobalTOC;
                 var relativePath = "/" + tocName + ".md";
@@ -75,9 +77,9 @@ internal string ConvertToHTML(IList<MarkdownFile> files)
                 var contents = files.Select(x => x.Content).ToList();
                 var tocContent = CreateGlobalTableOfContent(contents);
                 var tocString = string.Join("\n", tocContent);
-
                 var tocMarkdownFile = new MarkdownFile(new FileInfo(tocMDFilePath), relativePath, 0, relativePath, tocString);
-                files.Insert(0, tocMarkdownFile);
+
+                files.Insert(_options.GlobalTOCPosition, tocMarkdownFile);
             }
 
             for (var i = 0; i < files.Count; i++)
@@ -155,7 +157,7 @@ internal string ConvertToHTML(IList<MarkdownFile> files)
                 }
                 html = builder.ToString();
 
-                if (!string.IsNullOrEmpty(_options.GlobalTOC) && i == 0)
+                if (!string.IsNullOrEmpty(_options.GlobalTOC) && i == _options.GlobalTOCPosition)
                 {
                     html = RemoveDuplicatedHeadersFromGlobalTOC(html);
                     Log($"Removed duplicated headers from toc html", LogLevel.Information, 1);
@@ -185,7 +187,7 @@ internal string ConvertToHTML(IList<MarkdownFile> files)
                 }
 
 
-                if (!string.IsNullOrEmpty(_options.GlobalTOC) && i == 0 && !_options.Heading)
+                if (!string.IsNullOrEmpty(_options.GlobalTOC) && i == _options.GlobalTOCPosition && !_options.Heading)
                 {
                     var heading = $"<h1>{_options.GlobalTOC}</h1>";
                     html = heading + html;

diff --git a/AzureDevOps.WikiPDFExport/Options.cs b/AzureDevOps.WikiPDFExport/Options.cs
@@ -95,6 +95,9 @@ public class Options
         [Option("globaltoc", Required = false, HelpText = "Title for a global table of content for all markdown files. When not specified each markdown creates its own toc if defined")]
         public string GlobalTOC { get; set; }
 
+        [Option("globaltocposition", Required = false, HelpText = "Order of TOC within all files (starting from 0). When not specified TOC will be printed on the first page")]
+        public int GlobalTOCPosition { get; set; }
+
         [Option("printbackground", Required = false, HelpText = "Enable print background when using no header/footer template")]
         public bool PrintBackground { get; set; } = false;
 

diff --git a/README.md b/README.md
@@ -75,6 +75,9 @@ Provide a path to html files that will be added as header and footer. See [examp
 ### --GlobalTOC
 Title for a global table of content for all markdown files. When not specified each markdown creates its own toc if defined
 
+### --GlobalTOCPosition
+Order of TOC within all files (starting from 0). When not specified TOC will be printed on the first page
+
 ### --include-unlisted-pages
 By default only pages listed in `.order` files are considered. Setting this option any Markdown file (`.md`) found will be included as-well.