pagesmark/docs/usage.html at main · theworker02/pagesmark · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>pagesmark usage · 1.00</title>
  <link rel="stylesheet" href="styles.css">
</head>
<body>
  <nav class="nav sans">
    <a class="brand-lockup" href="index.html"><img src="logo.svg" alt=""> pagesmark</a>
    <div class="links">
      <a href="index.html#overview">Overview</a>
      <a href="index.html#install">Install</a>
      <a href="usage.html">Usage</a>
      <a href="index.html#examples">Examples</a>
      <a href="https://github.com/theworker02/pagesmark">GitHub</a>
      <a href="https://github.com/theworker02/pagesmark/releases/tag/v1.0.0">1.00</a>
    </div>
  </nav>

  <header class="hero">
    <img src="logo.svg" alt="pagesmark mark">
    <div>
      <p class="kicker sans">CLI reference · 1.00</p>
      <h1>pagesmark</h1>
      <p class="lede">Every flag, subcommand, and exit code. Same examples as the README.</p>
    </div>
  </header>
  <div class="wrap">
    <section>
      <h2>Synopsis</h2>
      <pre><code>pagesmark 1.00 (1.0.0)

Usage:
  pagesmark init [options] [dir]
  pagesmark check [options] [dir]

Write or inspect a GitHub Pages stub:
  docs/index.html
  docs/styles.css
  docs/logo.svg

Enable Pages with: Settings → Pages → Deploy from a branch → main → /docs

Subcommands:
  init               Create the three starter files (default)
  check              Verify those files already exist

Options:
  -h, --help         Show this help and exit 0
  -V, -v, --version  Print 1.0.0 and exit 0
  --json             JSON result
  --force            Overwrite existing docs files
  --title &lt;name&gt;     Title used in index.html (default: directory basename)
  --color &lt;#RRGGBB&gt;  Accent color (default #C9A227); navy stays #0B1F33

Exit codes:
  0  init wrote files, or check found all three
  1  missing files, refused overwrite, or bad --color

Examples:
  pagesmark init
  pagesmark init --title "My CLI" --color #C9A227
  pagesmark init --force ./website
  pagesmark check --json</code></pre>
      <div class="callout sans"><strong>Tip:</strong> <code>pagesmark --help</code> and <code>-h</code> print this text. <code>pagesmark --version</code> and <code>-V</code> print <code>1.0.0</code>.</div>
    </section>
    <section>
      <h2>Flags and arguments</h2>
      <p>The complete flag list is in <code>pagesmark --help</code> (shown above). Human output is the default; pass <code>--json</code> where supported.</p>
    </section>
    <section>
      <h2>Exit codes</h2>
      <table class="sans"><thead><tr><th>Code</th><th>Meaning</th></tr></thead><tbody><tr><td><code>0</code></td><td>init wrote files, or check found all three.</td></tr><tr><td><code>1</code></td><td>Missing files, refused overwrite, or bad --color.</td></tr></tbody></table>
    </section>
    <section>
      <h2>Configuration</h2>
      <p>Writes `docs/index.html`, `docs/styles.css`, and `docs/logo.svg`. Accent `--color` must be `#RRGGBB`.</p>
    </section>
    <section id="examples">
      <h2>Worked examples</h2>
      <h3 class="ok">Success path</h3>
      <p>Initialize a Pages stub, then check it.</p><pre><code>pagesmark init --title Demo
pagesmark check</code></pre><pre><code>wrote index.html, styles.css, logo.svg in /abs/docs
pagesmark: OK</code></pre>
      <h3 class="fail">Failure path</h3>
      <p>Existing docs refuse overwrite without --force.</p><pre><code>pagesmark init</code></pre><pre><code>docs already has index.html, styles.css, logo.svg; pass --force to overwrite</code></pre><p>Exit code is 1.</p>
    </section>
  </div>
  <footer class="sans">
    MIT © 2026 theworker02 · version <strong>1.00</strong> (<code>1.0.0</code>) ·
    navy <code>#0B1F33</code> · gold <code>#C9A227</code> ·
    <a href="https://github.com/theworker02/pagesmark">GitHub</a> ·
    <a href="https://thanks.dev/u/gh/theworker02">thanks.dev</a>
  </footer>
</body>
</html>