You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains the source for the [UserFrosting Learn](https://learn6.userfrosting.com) documentation website — the official documentation hub for [UserFrosting](https://github.com/userfrosting/UserFrosting).
8
+
9
+
The site is built on **UserFrosting 6** and serves versioned Markdown documentation pages from `app/pages/{version}/`. The frontend uses **Vite** and **Vue 3** with the Pink Cupcake theme.
10
+
11
+
## Running Locally
12
+
13
+
**Without Docker:**
14
+
```bash
15
+
# Terminal 1 – PHP backend
16
+
php bakery serve
17
+
18
+
# Terminal 2 – Vite dev server
19
+
npm run vite:dev
20
+
```
21
+
22
+
**With Docker:**
23
+
```bash
24
+
docker compose up -d
25
+
```
26
+
27
+
The app is available at `http://localhost:8080`.
28
+
29
+
## Building & Testing
30
+
31
+
```bash
32
+
# Frontend
33
+
npm run vite:build # Production build
34
+
npm run typecheck # TypeScript type checking
35
+
npm run lint # ESLint (auto-fix)
36
+
npm run test# Vitest unit tests
37
+
npm run coverage # Coverage report
38
+
39
+
# Backend
40
+
vendor/bin/phpunit # PHPUnit tests
41
+
vendor/bin/phpstan # Static analysis
42
+
```
43
+
44
+
## Contributing Documentation
45
+
46
+
Documentation pages live in `app/pages/{version}/` as Markdown files (e.g. `app/pages/6.0/01.quick-start/docs.md`). Folder numeric prefixes control sidebar ordering.
47
+
48
+
- Standalone pages use `docs.md`; chapter landing pages use `chapter.md`
49
+
- Images must be stored alongside pages and referenced with an absolute path starting with `/` (e.g. `/images/screenshot.png`)
50
+
- Internal links use absolute paths without version numbers (e.g. `/installation/requirements`)
0 commit comments