Skip to content

Commit 171d6bb

Browse files
committed
docs: expand and polish documentation site
1 parent 5577ed1 commit 171d6bb

File tree

17 files changed

+2487
-0
lines changed

17 files changed

+2487
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,23 @@ locationStub('/foo/bar?baz=qux#quux');
415415
console.log(location.pathname); // "/foo/bar"
416416
```
417417

418+
## Docs
419+
420+
A documentation site built with `preact-iso` lives in [`docs/`](./docs). It includes a quickstart, guides and a full API reference, all powered by the library itself. Install dependencies and start the dev server:
421+
422+
```
423+
cd docs
424+
npm install
425+
npm run dev
426+
```
427+
428+
To build the documentation for production:
429+
430+
```
431+
npm run build
432+
```
433+
434+
418435
## License
419436

420437
[MIT](./LICENSE)

docs/.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

docs/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<link rel="preconnect" href="https://fonts.googleapis.com" />
8+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
9+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" rel="stylesheet" />
10+
<title>preact-iso docs</title>
11+
</head>
12+
<body>
13+
<div id="app"></div>
14+
<script type="module" src="/src/main.jsx"></script>
15+
</body>
16+
</html>

0 commit comments

Comments
 (0)