Skip to content

Commit 8322ee9

Browse files
docs: point README at the GitHub Pages landing and document Pages setup
1 parent 274432b commit 8322ee9

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A secure, modern web interface for managing SSL certificates using the mkcert CLI tool. Generate, download, and manage local development certificates with enterprise-grade security and an intuitive web interface.
44

5+
> 🖥️ **Landing page:** a terminal-themed project page lives in [`/docs`](docs/) and is published via GitHub Pages (Settings → Pages → Deploy from branch → `main` / `/docs`).
6+
57
## ✨ Key Features
68

79
- **🔐 Certificate Generation**: Create certificates for multiple domains and IP addresses

docs/PAGES.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GitHub Pages — terminal landing
2+
3+
The landing site is plain static files in `docs/` (no build step):
4+
5+
- `docs/index.html` — the page
6+
- `docs/assets/` — styles, scripts, self-hosted fonts, screenshot
7+
- `docs/.nojekyll` — serve as-is (skip Jekyll)
8+
9+
## Enable / update
10+
11+
1. Repo **Settings → Pages**.
12+
2. **Source:** Deploy from a branch.
13+
3. **Branch:** `main`, **Folder:** `/docs`. Save.
14+
4. Wait for the deploy, then visit the published URL.
15+
16+
Editing any file under `docs/` and pushing to `main` redeploys automatically.
17+
18+
## Local preview
19+
20+
```bash
21+
python3 -m http.server 8080 --directory docs
22+
# http://localhost:8080/
23+
```

0 commit comments

Comments
 (0)