Hugoifier

hugoifier / docs / getting-started / quickstart.md
1
# Quick Start
2
3
## Convert a Hugo Theme
4
5
Most Hugo themes include an `exampleSite/` directory. Hugoifier assembles a complete, working site from it:
6
7
```bash
8
export ANTHROPIC_API_KEY=your_key
9
10
python src/cli.py complete themes/my-hugo-theme
11
# → output/my-hugo-theme/
12
```
13
14
Then test it:
15
16
```bash
17
cd output/my-hugo-theme
18
hugo serve
19
# Open http://localhost:1313
20
```
21
22
The Decap CMS admin panel is automatically available at `http://localhost:1313/admin/`.
23
24
## Convert Raw HTML
25
26
For a plain HTML/CSS theme:
27
28
```bash
29
python src/cli.py complete path/to/html-theme/
30
# → output/html-theme/
31
```
32
33
Hugoifier sends the main HTML file to the AI backend and converts it to Hugo layout files (`_default/baseof.html`, `partials/header.html`, etc.).
34
35
## Custom Output Directory
36
37
```bash
38
python src/cli.py complete themes/my-theme --output /tmp/my-site
39
```
40
41
## Whitelabel Decap CMS
42
43
```bash
44
python src/cli.py complete themes/my-theme \
45
--cms-name "My CMS" \
46
--cms-color "#1a1a2e" \
47
--cms-logo "https://example.com/logo.png"
48
```
49
50
## Switch AI Backend
51
52
```bash
53
# Use OpenAI instead of Anthropic
54
HUGOIFIER_BACKEND=openai OPENAI_API_KEY=your_key python src/cli.py complete themes/my-theme
55
56
# Or via CLI flag
57
python src/cli.py --backend openai complete themes/my-theme
58
```
59

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button