Merge 91d488f into c85463d

dotnet · Oct 30, 2023 · 2cfa902 · 2cfa902
2 parents c85463d + 91d488f
commit 2cfa902
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 20 deletions.
diff --git a/samples/seed/articles/toc.yml b/samples/seed/articles/toc.yml
@@ -1,4 +1,5 @@
 pdfFileName: seed.pdf
+pdfCoverPage: ../pdf.html
 items:
 - name: Getting Started
   href: docfx_getting_started.md

diff --git a/samples/seed/pdf.md b/samples/seed/pdf.md
@@ -0,0 +1,17 @@
+<style>    
+@media print {
+    @page {
+        margin: 0 !important;
+    }
+    body {
+        -webkit-print-color-adjust: exact;
+        -moz-print-color-adjust: exact;
+        -ms-print-color-adjust: exact;
+        print-color-adjust: exact;
+    }
+}
+</style>
+<div style='background-color: green; width: 100%; height: 100%; display: flex; flex-direction: column'>
+  <p style='flex: 1'></p>
+  <h1 style='align-self: end; margin: 1rem 2rem; color: antiquewhite'>DOCFX PDF SAMPLE</h1>
+</div>
diff --git a/src/Docfx.App/PdfBuilder.cs b/src/Docfx.App/PdfBuilder.cs
@@ -33,8 +33,7 @@ class Outline
 
         public bool pdf { get; init; }
         public string? pdfFileName { get; init; }
-        public string? pdfMargin { get; init; }
-        public bool pdfPrintBackground { get; init; }
+        public string? pdfCoverPage { get; init; }
     }
 
     public static Task Run(BuildJsonConfig config, string configDirectory, string? outputDirectory = null)
@@ -111,24 +110,22 @@ static async Task CreatePdf(IBrowser browser, Uri outlineUrl, Outline outline, s
         var pageNumbers = new Dictionary<Outline, int>();
         var nextPageNumbers = new Dictionary<Outline, int>();
         var nextPageNumber = 1;
-        var margin = outline.pdfMargin ?? "0.4in";
 
         await AnsiConsole.Progress().Columns(new SpinnerColumn(), new TaskDescriptionColumn { Alignment = Justify.Left }).StartAsync(async c =>
         {
             await Parallel.ForEachAsync(pages, async (item, CancellationToken) =>
             {
                 var task = c.AddTask(item.url.PathAndQuery);
                 var page = await browser.NewPageAsync();
-                await page.GotoAsync(item.url.ToString());
+                var response = await page.GotoAsync(item.url.ToString());
+                if (response is null || !response.Ok)
+                    throw new InvalidOperationException($"Failed to build PDF page [{response?.Status}]: {item.url}");
+
                 await page.AddScriptTagAsync(new() { Content = EnsureHeadingAnchorScript });
                 await page.WaitForLoadStateAsync(LoadState.NetworkIdle);
-                var bytes = await page.PdfAsync(new()
-                {
-                    PrintBackground = outline.pdfPrintBackground,
-                    Margin = new() { Bottom = margin, Top = margin, Left = margin, Right = margin },
-                });
+                var bytes = await page.PdfAsync();
                 File.WriteAllBytes(item.path, bytes);
-                task.Value = task.MaxValue;
+                task.StopTask();
             });
         });
 
@@ -137,21 +134,33 @@ await Parallel.ForEachAsync(pages, async (item, CancellationToken) =>
 
         IEnumerable<(string path, Uri url, Outline node)> GetPages(Outline outline)
         {
+            if (!string.IsNullOrEmpty(outline.pdfCoverPage))
+            {
+                var url = new Uri(outlineUrl, outline.pdfCoverPage);
+                if (url.Host == outlineUrl.Host)
+                    yield return (GetFilePath(url), url, new() { href = outline.pdfCoverPage });
+            }
+
             if (!string.IsNullOrEmpty(outline.href))
             {
                 var url = new Uri(outlineUrl, outline.href);
                 if (url.Host == outlineUrl.Host)
-                {
-                    var id = Convert.ToHexString(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(url.ToString()))).Substring(0, 6).ToLower();
-                    var name = Regex.Replace(url.PathAndQuery, "\\W", "-").Trim('-');
-                    yield return (Path.Combine(tempDirectory, $"{name}-{id}.pdf"), url, outline);
-                }
+                    yield return (GetFilePath(url), url, outline);
             }
 
             if (outline.items != null)
+            {
                 foreach (var item in outline.items)
                     foreach (var url in GetPages(item))
                         yield return url;
+            }
+        }
+
+        string GetFilePath(Uri url)
+        {
+            var id = Convert.ToHexString(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(url.ToString()))).Substring(0, 6).ToLower();
+            var name = Regex.Replace(url.PathAndQuery, "\\W", "-").Trim('-');
+            return Path.Combine(tempDirectory, $"{name}-{id}.pdf");
         }
 
         void MergePdf()
@@ -254,11 +263,14 @@ IEnumerable<BookmarkNode> CreateBookmarks(Outline[]? items, int level = 0)
                     continue;
                 }
 
-                nextPageNumber = nextPageNumbers[item];
-                yield return new DocumentBookmarkNode(
-                    item.name, level,
-                    new(pageNumbers[item], ExplicitDestinationType.XyzCoordinates, ExplicitDestinationCoordinates.Empty),
-                    CreateBookmarks(item.items, level + 1).ToArray());
+                if (!string.IsNullOrEmpty(item.name))
+                {
+                    nextPageNumber = nextPageNumbers[item];
+                    yield return new DocumentBookmarkNode(
+                        item.name, level,
+                        new(pageNumbers[item], ExplicitDestinationType.XyzCoordinates, ExplicitDestinationCoordinates.Empty),
+                        CreateBookmarks(item.items, level + 1).ToArray());
+                }
             }
         }
     }

diff --git a/templates/modern/src/docfx.scss b/templates/modern/src/docfx.scss
@@ -73,3 +73,9 @@ article {
     display: none;
   }
 }
+
+@media print {
+  @page {
+    margin: .4in;
+  }
+}
diff --git a/templates/modern/src/layout.scss b/templates/modern/src/layout.scss
@@ -70,12 +70,18 @@ body[data-layout="landing"] {
     padding-bottom: $main-padding-bottom;
 
     >.content {
+      display: flex;
+      flex-direction: column;
       width: 100%;
 
       >:not(article) {
         display: none;
       }
 
+      >article {
+        flex: 1;
+      }
+
       @include media-breakpoint-up(md) {
         >article [id] {
           scroll-margin-top: $header-height;
@@ -89,6 +95,10 @@ body[data-layout="landing"] {
   }
 
   @media print {
+    >main {
+      padding: 0 !important;
+    }
+
     >header, >footer {
       display: none;
     }