From 9b3822673c4acfd045e5a8b443c1b744589d2959 Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Sat, 6 Jan 2024 10:53:30 +0800 Subject: [PATCH 1/2] feat: support description metadata --- src/Docfx.Build/SystemMetadata.cs | 15 --------------- templates/default/partials/head.tmpl.partial | 1 + templates/modern/layout/_master.tmpl | 1 + 3 files changed, 2 insertions(+), 15 deletions(-) diff --git a/src/Docfx.Build/SystemMetadata.cs b/src/Docfx.Build/SystemMetadata.cs index 444990fec92..a76946c745d 100644 --- a/src/Docfx.Build/SystemMetadata.cs +++ b/src/Docfx.Build/SystemMetadata.cs @@ -8,21 +8,6 @@ namespace Docfx.Build.Engine; class SystemMetadata { - [JsonProperty("_title")] - [JsonPropertyName("_title")] - public string Title { get; set; } - - [JsonProperty("_tocTitle")] - [JsonPropertyName("_tocTitle")] - public string TocTitle { get; set; } - - [JsonProperty("_name")] - [JsonPropertyName("_name")] - public string Name { get; set; } - - [JsonProperty("_description")] - [JsonPropertyName("_description")] - public string Description { get; set; } /// /// TOC PATH from ~ ROOT diff --git a/templates/default/partials/head.tmpl.partial b/templates/default/partials/head.tmpl.partial index 2853cad2b39..c801f7e5327 100644 --- a/templates/default/partials/head.tmpl.partial +++ b/templates/default/partials/head.tmpl.partial @@ -20,6 +20,7 @@ {{#_description}}{{/_description}} + {{#description}}{{/description}} diff --git a/templates/modern/layout/_master.tmpl b/templates/modern/layout/_master.tmpl index 70089790859..371f5720d99 100644 --- a/templates/modern/layout/_master.tmpl +++ b/templates/modern/layout/_master.tmpl @@ -14,6 +14,7 @@ {{#_description}}{{/_description}} + {{#description}}{{/description}} From 04e8bab5d456a6aac4dc402714c1394ac3956390 Mon Sep 17 00:00:00 2001 From: yufeih Date: Sat, 6 Jan 2024 02:58:58 +0000 Subject: [PATCH 2/2] test(snapshot): update snapshots f767f49beaa87f0980881ebd11ed51fd882039cb for ubuntu-latest --- .../html/api-BuildFromProject.Class1.html.verified.html | 1 + .../html/api-CatLibrary.Cat-2.html-q-cat.verified.html | 1 + .../html/api-CatLibrary.html-term-cat.verified.html | 1 + .../SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html | 1 + .../html/articles-csharp_coding_standards.html.verified.html | 1 + ...l-tabs-windows-2Ctypescript-markdown-extensions.verified.html | 1 + .../SamplesTest.SeedHtml/html/index.html.verified.html | 1 + .../html/restapi-petstore.html.verified.html | 1 + 8 files changed, 8 insertions(+) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html index 05a847e2ae5..155b1dc7360 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html @@ -6,6 +6,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html index 3b112e52d13..c4dcdef9b97 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html @@ -6,6 +6,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html index 16ba3427da3..a62858c0a75 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html @@ -6,6 +6,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html index d7c98b426ae..8805979c46f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html @@ -6,6 +6,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html index 219f8335364..fbdc46d6076 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html @@ -4,6 +4,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html index 914632c05c9..f018c441b7e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html @@ -4,6 +4,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html index 4493c982fc7..f00f4a2d2d5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html @@ -4,6 +4,7 @@ + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html index cfc8fa0c262..76d7baf1171 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html @@ -4,6 +4,7 @@ +