Hugoifier

hugoifier / docs / index.md

Source Rendered

Blame History Raw 83 lines

1	`# Hugoifier`
2
3	`AI-powered Hugo theme converter with Decap CMS integration.`
4
5	`Hugoifier converts any HTML/CSS theme into a production-ready Hugo site — complete with layouts, content structure, and a fully configured Decap CMS admin panel. Supports Anthropic Claude, OpenAI GPT-4, and Google Gemini as AI backends.`
6
7	`---`
8
9	`## Features`
10
11	`- HTML → Hugo — AI converts raw HTML/CSS templates into valid Hugo Go template files with proper partials, blocks, and template variables`
12	- Multi-backend AI — Route to Anthropic (default), OpenAI, or Google Gemini via `HUGOIFIER_BACKEND`
13	- Decap CMS out of the box — Auto-generates `static/admin/config.yml` by introspecting your content structure, including deeply nested collections
14	- Hugo API modernization — Automatically patches deprecated Hugo APIs (`.Site.DisqusShortname`, `.Site.GoogleAnalytics`, `paginate`, etc.) for Hugo ≥ v0.128
15	`- Whitelabel CMS — Customize the Decap admin panel name, logo, and color per deployment`
16	- Smart theme detection — Handles messy zip-extracted directory structures, skips `__MACOSX` artifacts, detects `exampleSite` automatically
17	- Docker support — Fully containerized with `docker-compose.yml`
18
19	`## Quick Start`
20
21	```bash
22	`# Install dependencies`
23	`pip install -r requirements.txt`
24
25	`# Set your AI backend key`
26	`export ANTHROPIC_API_KEY=your_key_here`
27
28	`# Convert a Hugo theme`
29	`python src/cli.py complete themes/my-theme`
30
31	`# Convert raw HTML`
32	`python src/cli.py complete path/to/html-theme/`
33
34	`# Output goes to output/{theme-name}/ by default`
35	`cd output/my-theme && hugo serve`
36	```
37
38	`## Installation`
39
40	`=== "From source"`
41
42	```bash
43	`git clone https://github.com/ConflictHQ/hugoifier.git`
44	`cd hugoifier`
45	`pip install -r requirements.txt`
46	```
47
48	`=== "Docker"`
49
50	```bash
51	`git clone https://github.com/ConflictHQ/hugoifier.git`
52	`cd hugoifier`
53	`ANTHROPIC_API_KEY=your_key docker compose up`
54	```
55
56	`## Requirements`
57
58	`- Python 3.11+`
59	- At least one AI API key: `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, or `GOOGLE_API_KEY`
60	`- Hugo extended (for building the output site)`
61
62	`## Pipeline Overview`
63
64	```
65	`Input (Hugo theme or raw HTML)`
66	`↓`
67	`[Theme Finder] — detect Hugo theme vs raw HTML`
68	`↓`
69	`[Hugoify] — AI converts HTML → Hugo layouts (raw HTML only)`
70	`↓`
71	`[Assemble] — copy theme + exampleSite, write hugo.toml`
72	`↓`
73	`[Theme Patcher] — fix deprecated Hugo APIs`
74	`↓`
75	`[Decapify] — generate Decap CMS config from content structure`
76	`↓`
77	`output/{theme-name}/ ← ready to run with hugo serve`
78	```
79
80	`## License`
81
82	`MIT License — Copyright © 2026 CONFLICT LLC. All rights reserved.`
83

Hugoifier

Keyboard Shortcuts