mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title> </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content=" ">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.min.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 Terminal.Gui.</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/Terminal.Gui/">https://gui-cs.github.io/Terminal.Gui/</a>.</p>
<p>NOTE: the v2 are generated from another repository (<a href="https://github.com/gui-cs/Terminal.GuiV2Docs">https://github.com/gui-cs/Terminal.GuiV2Docs</a>) and are published here: <a href="https://gui-cs.github.io/Terminal.GuiV2Docs/">https://gui-cs.github.io/Terminal.GuiV2Docs/</a>.</p>
<h2 id="to-generate-the-docs-locally">To Generate the Docs Locally</h2>
<ol start="0">
<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 http://localhost:8080 and verify everything looks good.</li>
<li>Hit ctrl-c to stop the script.</li>
</ol>
</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/Terminal.Gui/blob/develop/docfx/README.md/#L1" class="contribution-link">Edit this page</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.min.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>