Skip to content

Commit

Permalink
deploy: a3ea9b3
Browse files Browse the repository at this point in the history
  • Loading branch information
@tig
tig committed Jan 22, 2024
0 parents commit 3686c14
Show file tree
Hide file tree
Showing 43 changed files with 34,690 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
124 changes: 124 additions & 0 deletions README.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>To Generate the Docs Locally </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="To Generate the Docs Locally ">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">

<p>This folder generates the API docs for NStack. </p>
<p>The API documentation is generated via a GitHub Action (<code>.github/workflows/api-docs.yml</code>) using <a href="https://github.com/dotnet/docfx">DocFX</a>. The Action publishes the docs to the <code>gh-pages</code> branch, which gets published to <a href="https://gui-cs.github.io/NStack/">https://gui-cs.github.io/NStack/</a>.</p>
<h2 id="to-generate-the-docs-locally">To Generate the Docs Locally</h2>
<ol>
<li>Install DotFX <a href="https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html">https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html</a></li>
<li>Change to the <code>./docfx</code> folder and run <code>./build.ps1</code></li>
<li>Browse to <a href="http://localhost:8080">http://localhost:8080</a> and verify everything looks good.</li>
<li>Hit ctrl-c to stop the script.</li>
</ol>
<p>If <code>docfx</code> fails with a <code>Stackoverflow</code> error. Just run it again. And again. Sometimes it takes a few times. If that doesn&#39;t work, create a fresh clone or delete the <code>docfx/api</code>, <code>docfx/obj</code>, and <code>docs/</code> folders and run the steps above again.</p>
<p>Note the <code>./docfx/build.ps1</code> script will create a <code>./docs</code> folder. This folder is ignored by <code>.gitignore</code>.</p>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/gui-cs/NStack/blob/develop/docfx/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
170 changes: 170 additions & 0 deletions api/NStack/NStack.Unicode.Case.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum Unicode.Case
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum Unicode.Case
">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">

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

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="NStack.Unicode.Case">


<h1 id="NStack_Unicode_Case" data-uid="NStack.Unicode.Case" class="text-break">Enum Unicode.Case
</h1>
<div class="markdown level0 summary">
The types of cases supported.
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="NStack.html">NStack</a></h6>
<h6><strong>Assembly</strong>: NStack.dll</h6>
<h5 id="NStack_Unicode_Case_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum Case</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="NStack_Unicode_Case_Lower">Lower</td>
<td>
Lower case
</td>
</tr>
<tr>
<td id="NStack_Unicode_Case_Title">Title</td>
<td>
Titlecase capitalizes the first letter, and keeps the rest in lowercase.
Sometimes it is not as straight forward as the uppercase, some characters require special handling, like
certain ligatures and greek characters.
</td>
</tr>
<tr>
<td id="NStack_Unicode_Case_Upper">Upper</td>
<td>
Upper case
</td>
</tr>
</tbody>
</thead></thead></table>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/gui-cs/NStack/new/develop/docfx/overrides/new?filename=NStack_Unicode_Case.md&amp;value=---%0Auid%3A%20NStack.Unicode.Case%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/gui-cs/NStack/blob/main/NStack/unicode/Letter.cs/#L184" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit 3686c14

Please sign in to comment.