Skip to content

Commit

Permalink
deploy: f54b71a
Browse files Browse the repository at this point in the history
  • Loading branch information
netpyoung committed Dec 10, 2024
1 parent 95a8700 commit db2afec
Show file tree
Hide file tree
Showing 11 changed files with 302 additions and 134 deletions.
48 changes: 4 additions & 44 deletions api/NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="NF_Tool_ReleaseNoteMaker_Common_Template_TemplateRenderer" data-uid="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer" class="text-break">
Class TemplateRenderer <a class="header-action link-secondary" title="View source" href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L16"><i class="bi bi-code-slash"></i></a>
Class TemplateRenderer <a class="header-action link-secondary" title="View source" href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L17"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -127,51 +127,11 @@ <h2 class="section" id="methods">Methods
</h2>


<a id="NF_Tool_ReleaseNoteMaker_Common_Template_TemplateRenderer_Render_" data-uid="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer.Render*"></a>

<h3 id="NF_Tool_ReleaseNoteMaker_Common_Template_TemplateRenderer_Render_System_String_NF_Tool_ReleaseNoteMaker_Common_Config_ReleaseNoteConfig_NF_Tool_ReleaseNoteMaker_Common_Template_TemplateModel_" data-uid="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer.Render(System.String,NF.Tool.ReleaseNoteMaker.Common.Config.ReleaseNoteConfig,NF.Tool.ReleaseNoteMaker.Common.Template.TemplateModel)">
Render(string, ReleaseNoteConfig, TemplateModel)
<a class="header-action link-secondary" title="View source" href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L18"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Task&lt;(Exception? exOrNull, string text)&gt; Render(string templatePath, ReleaseNoteConfig config, TemplateModel templateModel)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>templatePath</code> <span class="xref">string</span></dt>
<dd></dd>
<dt><code>config</code> <a class="xref" href="NF.Tool.ReleaseNoteMaker.Common.Config.ReleaseNoteConfig.html">ReleaseNoteConfig</a></dt>
<dd></dd>
<dt><code>templateModel</code> <a class="xref" href="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateModel.html">TemplateModel</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span>&lt;(<span class="xref">Exception</span> <span class="xref">exOrNull</span>, <span class="xref">string</span> <span class="xref">text</span>)&gt;</dt>
<dd></dd>
</dl>











<a id="NF_Tool_ReleaseNoteMaker_Common_Template_TemplateRenderer_RenderFragments_" data-uid="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer.RenderFragments*"></a>

<h3 id="NF_Tool_ReleaseNoteMaker_Common_Template_TemplateRenderer_RenderFragments_System_String_NF_Tool_ReleaseNoteMaker_Common_Config_ReleaseNoteConfig_NF_Tool_ReleaseNoteMaker_Common_Template_ProjectData_System_Collections_Generic_List_NF_Tool_ReleaseNoteMaker_Common_Fragments_FragmentContent__" data-uid="NF.Tool.ReleaseNoteMaker.Common.Template.TemplateRenderer.RenderFragments(System.String,NF.Tool.ReleaseNoteMaker.Common.Config.ReleaseNoteConfig,NF.Tool.ReleaseNoteMaker.Common.Template.ProjectData,System.Collections.Generic.List{NF.Tool.ReleaseNoteMaker.Common.Fragments.FragmentContent})">
RenderFragments(string, ReleaseNoteConfig, ProjectData, List&lt;FragmentContent&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L46"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L73"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
Expand All @@ -195,7 +155,7 @@ <h4 class="section">Parameters</h4>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Task</span>&lt;(<span class="xref">Exception</span> <span class="xref">exOrNull</span>, <span class="xref">string</span> <span class="xref">text</span>)&gt;</dt>
<dt><span class="xref">Task</span>&lt;(<span class="xref">Exception</span>, <span class="xref">string</span>)&gt;</dt>
<dd></dd>
</dl>

Expand All @@ -213,7 +173,7 @@ <h4 class="section">Returns</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L16" class="edit-link">Edit this page</a>
<a href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/NF.Tool.ReleaseNoteMaker/NF.Tool.ReleaseNoteMaker.Common/Template/TemplateRenderer.cs/#L17" class="edit-link">Edit this page</a>
</div>


Expand Down
116 changes: 116 additions & 0 deletions docs/changelog.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ChangeLog | NF.Tool.ReleaseNoteMaker </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="ChangeLog | NF.Tool.ReleaseNoteMaker ">


<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/docfx/docs/changelog.md/#L1">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="NF.Tool.ReleaseNoteMaker">
NF.Tool.ReleaseNoteMaker
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="">
<h1 id="changelog">ChangeLog</h1>


</article>

<div class="contribution d-print-none">
<a href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/docfx/docs/changelog.md/#L1" class="edit-link">Edit this page</a>
</div>

<div class="next-article d-print-none border-top" id="nextArticle"></div>

</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
46 changes: 25 additions & 21 deletions docs/concept.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,27 +87,31 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<article data-uid="">
<h1 id="concept">Concept</h1>

<p>news fragments/newsfiles/topfiles</p>
<h2 id="example">Example</h2>
<pre><code class="lang-txt">USAGE:
dotnet release-note [OPTIONS] &lt;COMMAND&gt;

EXAMPLES:
dotnet release-note init
dotnet release-note create --edit
dotnet release-note create 1.added.md --content &quot;Hello World&quot;
dotnet release-note build --version 1.0.0
dotnet release-note check

OPTIONS:
-h, --help Prints help information

COMMANDS:
init Init release-note setup
create Create a new fragment
preview Preview a release note
build Build a release note
check Checks files changed
<h2 id="flow">Flow</h2>
<pre><code class="lang-mermaid">flowchart LR


Files[&quot;`
1.added.md
2.fixed.md
3.security.md
...
`&quot;]

Renderer{Renderer}
Output[ChangeLog.md]

Files --&gt; Fragments

subgraph ReleaseNoteMaker
Fragments --&gt;|Arragne| Model(Model)
Model --&gt; Renderer
end

Renderer --&gt;|t4 | Output
Renderer --&gt;|liquid| Output

style Files text-align:left
</code></pre>

</article>
Expand Down
3 changes: 2 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h2 id="install">Install</h2>
</code></pre>
<h2 id="document">Document</h2>
<ul>
<li><a href="https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/concept.html">Documentation</a></li>
<li><a href="https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/docs/concept.html">Documentation</a></li>
</ul>
<h2 id="dependencies">Dependencies</h2>
<ul>
Expand All @@ -113,6 +113,7 @@ <h2 id="dependencies">Dependencies</h2>
<li>use <a href="https://spectreconsole.net/">Spectre.Console</a> for console output.</li>
<li>use <a href="https://spectreconsole.net/cli/">Spectre.Console.Cli</a> for parse args.</li>
<li>use <a href="https://github.com/axuno/SmartFormat">SmartFormat</a> for format string.</li>
<li>use <a href="https://github.com/sebastienros/fluid">sebastienros/fluid</a> for <a href="https://shopify.github.io/liquid/">liquid</a></li>
</ul>
<h2 id="license">License</h2>
<p>This project is licensed under the MIT License. See the <a href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/LICENSE.md">LICENSE</a> file for details.</p>
Expand Down
22 changes: 12 additions & 10 deletions docs/setup/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,14 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<article data-uid="">
<h1 id="template">Template</h1>

<pre><code class="lang-mermaid">flowchart LR

A[Hard] --&gt;|Text| B(Round)
B --&gt; C{Decision}
C --&gt;|One| D[Result 1]
C --&gt;|Two| E[Result 2]
</code></pre>
<ul>
<li>support
<ul>
<li><a href="https://learn.microsoft.com/en-us/visualstudio/modeling/code-generation-and-t4-text-templates">T4 template</a></li>
<li><a href="https://shopify.github.io/liquid/">liquid</a></li>
</ul>
</li>
</ul>
<div class="tabGroup" id="tabgroup_1">
<ul role="tablist">
<li role="presentation">
Expand Down Expand Up @@ -202,9 +203,10 @@ <h1 id="template">Template</h1>
#&gt;
</code></pre></section>
<section id="tabpanel_1_liquid" role="tabpanel" data-tab="liquid" aria-hidden="true" hidden="hidden">

<p>Content for Windows...</p>
</section>
<pre><code class="lang-liquid" name="Default">{%- if model.IsRenderTitle -%}
# {{ model.ProjectData }}
{%- endif -%}
</code></pre></section>
</div>

<p>Hello WOrld</p>
Expand Down
3 changes: 3 additions & 0 deletions docs/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@
</li>
</ul>
</li>
<li>
<a href="changelog.html" name="" title="ChangeLog">ChangeLog</a>
</li>
<li>
<a href="https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker" name="" title="&#128230; Github">&#128230; Github</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/toc.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

{"items":[{"name":"NF.Tool.ReleaseNoteMaker","href":"index.html","topicHref":"index.html"},{"name":"Concept","href":"concept.html","topicHref":"concept.html"},{"name":"Tutorial","href":"tutorial.html","topicHref":"tutorial.html"},{"name":"Command","items":[{"name":"Init","href":"command/command_init.html","topicHref":"command/command_init.html"},{"name":"Create","href":"command/command_create.html","topicHref":"command/command_create.html"},{"name":"Preview","href":"command/command_preview.html","topicHref":"command/command_preview.html"},{"name":"Build","href":"command/command_build.html","topicHref":"command/command_build.html"},{"name":"Check","href":"command/command_check.html","topicHref":"command/command_check.html"}]},{"name":"Setup","items":[{"name":"ReleaseNote.config.toml","href":"setup/config.html","topicHref":"setup/config.html"},{"name":"Template","href":"setup/template.html","topicHref":"setup/template.html"}]},{"name":"📦 Github","href":"https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker","topicHref":"https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker"}],"pdf":false}
{"items":[{"name":"NF.Tool.ReleaseNoteMaker","href":"index.html","topicHref":"index.html"},{"name":"Concept","href":"concept.html","topicHref":"concept.html"},{"name":"Tutorial","href":"tutorial.html","topicHref":"tutorial.html"},{"name":"Command","items":[{"name":"Init","href":"command/command_init.html","topicHref":"command/command_init.html"},{"name":"Create","href":"command/command_create.html","topicHref":"command/command_create.html"},{"name":"Preview","href":"command/command_preview.html","topicHref":"command/command_preview.html"},{"name":"Build","href":"command/command_build.html","topicHref":"command/command_build.html"},{"name":"Check","href":"command/command_check.html","topicHref":"command/command_check.html"}]},{"name":"Setup","items":[{"name":"ReleaseNote.config.toml","href":"setup/config.html","topicHref":"setup/config.html"},{"name":"Template","href":"setup/template.html","topicHref":"setup/template.html"}]},{"name":"ChangeLog","href":"changelog.html","topicHref":"changelog.html"},{"name":"📦 Github","href":"https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker","topicHref":"https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker"}],"pdf":false}
Loading

0 comments on commit db2afec

Please sign in to comment.