264 lines
4.7 KiB
HTML
264 lines
4.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>Documentation</title>
|
|
<style>
|
|
html, body {
|
|
min-height: 100%;
|
|
margin: 0;
|
|
padding: 0;
|
|
background: #0f1113;
|
|
color: #e6eef3;
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
|
|
line-height: 1.5;
|
|
-webkit-font-smoothing: antialiased;
|
|
-moz-osx-font-smoothing: grayscale;
|
|
}
|
|
|
|
main {
|
|
max-width: 830px;
|
|
margin: 0 auto;
|
|
padding: 36px;
|
|
}
|
|
|
|
header {
|
|
margin-bottom: 36px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 40px;
|
|
font-weight: 700;
|
|
margin: 0 0 20px 0;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 32px;
|
|
margin: 26px 0 14px;
|
|
border-bottom: 1px solid rgba(255,255,255,.1);
|
|
padding-bottom: 6px;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 26px;
|
|
margin: 22px 0 12px;
|
|
}
|
|
|
|
p {
|
|
margin: 14px 0;
|
|
}
|
|
|
|
header p {
|
|
color: #9aa6b1;
|
|
}
|
|
|
|
nav {
|
|
margin: 28px 0;
|
|
padding: 20px;
|
|
background: #1a1c20;
|
|
border: 1px solid rgba(255,255,255,.06);
|
|
border-radius: 4px;
|
|
}
|
|
|
|
nav h2 {
|
|
font-size: 20px;
|
|
margin: 0 0 12px 0;
|
|
border: none;
|
|
padding: 0;
|
|
}
|
|
|
|
nav ul {
|
|
list-style: none;
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
|
|
nav li {
|
|
margin: 6px 0;
|
|
}
|
|
|
|
a {
|
|
color: #68a6ff;
|
|
text-decoration: none;
|
|
transition: color .15s ease;
|
|
}
|
|
|
|
a:hover {
|
|
text-decoration: underline;
|
|
}
|
|
|
|
section {
|
|
margin-top: 36px;
|
|
}
|
|
|
|
ul, ol {
|
|
margin: 14px 0;
|
|
padding-left: 26px;
|
|
}
|
|
|
|
li {
|
|
margin: 6px 0;
|
|
}
|
|
|
|
code {
|
|
padding: 3px 7px;
|
|
border-radius: 3px;
|
|
font-family: "SF Mono", Monaco, "Cascadia Code", "Roboto Mono", Consolas, "Courier New", monospace;
|
|
font-size: .9em;
|
|
color: #cde7ff;
|
|
background: #1a1c20;
|
|
border: 1px solid rgba(255,255,255,.06);
|
|
}
|
|
|
|
pre {
|
|
padding: 20px;
|
|
border-radius: 4px;
|
|
margin: 14px 0;
|
|
overflow-x: auto;
|
|
background: #1a1c20;
|
|
border: 1px solid rgba(255,255,255,.06);
|
|
font-family: "SF Mono", Monaco, "Cascadia Code", "Roboto Mono", Consolas, "Courier New", monospace;
|
|
font-size: 14px;
|
|
line-height: 1.6;
|
|
}
|
|
|
|
pre code {
|
|
background: none;
|
|
border: none;
|
|
padding: 0;
|
|
font-size: inherit;
|
|
color: inherit;
|
|
}
|
|
|
|
blockquote {
|
|
border-left: 3px solid #68a6ff;
|
|
padding-left: 18px;
|
|
margin: 14px 0;
|
|
color: #dfe9ee;
|
|
font-style: italic;
|
|
}
|
|
|
|
table {
|
|
width: 100%;
|
|
border-collapse: collapse;
|
|
margin: 14px 0;
|
|
}
|
|
|
|
th, td {
|
|
padding: 12px 16px;
|
|
text-align: left;
|
|
border-bottom: 1px solid rgba(255,255,255,.06);
|
|
}
|
|
|
|
th {
|
|
background: #1a1c20;
|
|
font-weight: 600;
|
|
color: #f0f6f8;
|
|
}
|
|
|
|
tr:hover {
|
|
background: rgba(255,255,255,.02);
|
|
}
|
|
|
|
footer {
|
|
margin-top: 48px;
|
|
padding-top: 20px;
|
|
border-top: 1px solid rgba(255,255,255,.1);
|
|
color: #9aa6b1;
|
|
font-size: 14px;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<header>
|
|
<h1>Documentation</h1>
|
|
<p>Yait: Yet Another Init Tool</p>
|
|
</header>
|
|
|
|
<nav>
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#introduction">Introduction</a></li>
|
|
<li><a href="#installation">Installation</a></li>
|
|
<li><a href="#quick">Quick Start</a></li>
|
|
<li><a href="#cli-reference">Cli Reference</a></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
<section id="introduction">
|
|
<h2>Introduction</h2>
|
|
<p>Yait, or Yet Another Init Tool, is a small shell script that templates minimal programs. It provides argument parsing and a general framework for your projects.</p>
|
|
</section>
|
|
|
|
<section id="installation">
|
|
<h2>Installation</h2>
|
|
<pre><code>git clone https://git.vxserver.dev/fSD/yait</code></pre>
|
|
<pre><code>cd fes</code></pre>
|
|
<pre><code>sudo make install</code></pre>
|
|
</section>
|
|
|
|
<section id="quick">
|
|
<h2>Quick Start</h2>
|
|
<pre><code>yait hello</code></pre>
|
|
<p>This creates a C project.</p>
|
|
<pre><code>yait -x sh hello</code></pre>
|
|
<p>This creates a SH project.</p>
|
|
|
|
<section id="cli-reference">
|
|
<h2>Cli Reference</h2>
|
|
<table> <thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--help</code></td>
|
|
<td>Display help information.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--version</code></td>
|
|
<td>Print version information.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-x <language></code></td>
|
|
<td>Set project language.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-d <description></code></td>
|
|
<td>Set a description.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-S</code></td>
|
|
<td>small project creation (only for shell scripts)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-f</code></td>
|
|
<td>overwrite existing files</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-d <author></code></td>
|
|
<td>Disable color output.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-r</code></td>
|
|
<td>Initalize a Git repository.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>-q</code></td>
|
|
<td>Suppress non-critical output.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
|
|
<footer>
|
|
<p>Last updated: 2026-01-22</p>
|
|
</footer>
|
|
</main>
|
|
</body>
|
|
</html>
|