tiennm99/HugoBlox-kit
1
0 Fork 0
mirror of https://github.com/tiennm99/HugoBlox-kit.git synced 2026-10-14 12:16:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
HugoBlox-kit/templates/starter/README.md
T
George Cushen a034cf7dbe docs: edit
2026-04-29 10:29:48 +01:00

230 lines
9.6 KiB
Markdown
Raw Permalink Blame History

# [HugoBlox Starter — Your Blank Canvas](https://github.com/HugoBlox/hugo-starter)
[![Screenshot](https://github.com/HugoBlox/kit/raw/main/.github/media/hero.png)](https://hugoblox.com/templates/starter?utm_source=github&utm_medium=readme&utm_content=preview)
<h1 align="center">Describe It. Deploy It. Own It.</h1>
<p align="center">
<strong>The fastest path from idea to live site.</strong><br/>
Start with a blank page. Tell AI what you want. Get a production site in minutes — not days.<br/>
Built on <a href="https://github.com/HugoBlox/kit">HugoBlox</a> — the open-source framework where AI generates your pages and you own everything as Markdown.
</p>
<p align="center">
<a href="https://hugoblox.com/templates/starter?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_starter"><b>Build with AI</b></a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://hugoblox.com/templates/starter?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
</p>
<div align="center">
<a href="https://github.com/HugoBlox/hugo-starter">
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-starter?label=Star&logo=github&style=flat-square&color=181717" alt="GitHub Stars">
</a>
<a href="https://discord.gg/z8wNYzb">
<img src="https://img.shields.io/discord/722225264733716590?label=Discord&logo=discord&logoColor=white&style=flat-square&color=5865F2" alt="Discord">
</a>
<a href="https://github.com/HugoBlox/kit">
<img src="https://img.shields.io/github/stars/HugoBlox/kit?label=HugoBlox&logo=github&style=flat-square&color=181717" alt="HugoBlox Stars">
</a>
</div>
<p align="center">
<sub>Part of the <a href="https://github.com/HugoBlox/kit"><strong>HugoBlox</strong></a> ecosystem · <strong>150,000+</strong> sites · Rated <strong>4.9/5</strong> (official survey) · Trusted since <strong>2016</strong></sub>
</p>
---
## How It Works
Other templates give you someone else's layout. This one gives you a blank page and an AI that builds exactly what you ask for.
<table>
<tr>
<td width="50%" valign="top">
### 1. Tell AI what you want
Open [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=how_it_works_starter) and describe your site in plain English:
> *"Build me a landing page for my SaaS with a hero, three feature columns, pricing table, and a contact form"*
> *"Create a research lab site with team profiles, a publications list, and a news feed"*
> *"I need a portfolio with a filterable project grid and an about page"*
Hugo Chat generates structured pages with correct front matter, blocks, and content — ready to paste in.
</td>
<td width="50%" valign="top">
### 2. Edit visually or in Markdown
Fine-tune with whichever workflow fits you:
**[Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)** — drag-and-drop editing inside VS Code. Rearrange blocks, update text, change design tokens. No terminal needed.
**Markdown** — every page is a file you can read and edit. Change a heading, add a section, commit and push.
**Hugo Chat** — come back anytime to generate new pages or refine existing ones.
### 3. Deploy free
Push to GitHub. Your site builds and deploys automatically via GitHub Pages. Zero cost, zero config.
</td>
</tr>
</table>
<p align="center">
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_mid_starter">
<img src="https://img.shields.io/badge/⚡️%20Start%20Building%20with%20AI-7c3aed?style=for-the-badge" alt="Build with AI" width="400">
</a>
</p>
---
## What You Can Build
This is a blank canvas with the full HugoBlox engine behind it. Add any combination of content types:
| Content type | URL | Use it for |
| :--- | :--- | :--- |
| **Landing pages** | any path | Hero sections, feature grids, CTAs, pricing — assembled from blocks |
| **Blog** | `/blog/` | Posts with dates, tags, categories, reading time |
| **Projects** | `/projects/` | Software, research projects, portfolio items |
| **Publications** | `/publications/` | Papers, articles, preprints with citation metadata |
| **Events** | `/events/` | Talks, webinars, workshops, conferences |
| **Datasets** | `/datasets/` | Research data with DOIs and download links |
| **Case studies** | `/case-studies/` | Customer stories, project showcases, impact reports |
| **Changelog** | `/changelog/` | Product updates, release notes, version history |
| **Courses** | `/courses/` | Lessons, tutorials, learning paths with breadcrumbs |
| **Docs** | `/docs/` | Documentation with sidebar navigation |
| **FAQ** | `/faq/` | Frequently asked questions |
| **Slides** | `/slides/` | Presentations from Markdown via reveal.js |
Every content type supports tags, categories, search, RSS, related content, and social sharing out of the box.
---
## 🚀 Get Started
### Step 1: Deploy Your Site
**Option A: Launch in browser** (fastest — no install needed)
> [!TIP]
> Deploy a live site in 60 seconds — no software to install:
> [**Deploy Starter free**](https://hugoblox.com/templates/starter?utm_source=github&utm_medium=readme&utm_content=get_started)
**Option B: Use the CLI**
```bash
# Requires Hugo Extended & Node.js
npx hugoblox create site --template starter
```
### Step 2: Build Pages With AI
Open [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_starter) and describe the pages you want. Paste the generated files into your `content/` folder. Push to GitHub — your site updates automatically.
### Step 3: Customize Visually
Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable) in VS Code to edit pages visually — rearrange blocks, update content, and preview changes without touching code.
![Ownable CMS in Action](https://raw.githubusercontent.com/HugoBlox/kit/main/.github/media/studio/slide-1.webp)
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
> [!NOTE]
> **New to Hugo?** No problem. You don't need to know Hugo — build with AI or edit visually. Hugo is the engine under the hood that makes your site fast, secure, and free to host. [Learn more →](https://docs.ownable.dev/?utm_source=github&utm_medium=readme&utm_content=docs_starter)
---
## 🏆 Why HugoBlox?
> *Why not just use WordPress, Webflow, or an AI builder like Lovable?*
| | **AI builders** (Lovable, v0) | **CMS platforms** (WordPress, Webflow) | **HugoBlox** |
| :--- | :---: | :---: | :---: |
| AI generates your pages | Yes | No | **Yes** |
| You own the output as readable files | No — React code | No — database | **Yes — Markdown** |
| Free to host forever | No | No | **Yes** |
| Human-editable without the tool | Barely | No | **Yes — it's Markdown** |
| Open source | No | No | **Yes — MIT licensed** |
> [!IMPORTANT]
> Your content is plain Markdown files. No lock-in, no database, no vendor dependency. If you ever want to leave, take your files and go.
---
## FAQ
<details>
<summary><b>Do I need to know Hugo?</b></summary>
No. Build with Hugo Chat or edit visually with Ownable CMS. Hugo is the build engine — you don't need to touch it.
</details>
<details>
<summary><b>Why use this instead of a purpose-built template?</b></summary>
If you know what you want — a CV, a blog, a docs site — use those templates. The starter is for when you want full control, or when you're building something that doesn't fit a predefined layout. It's also the ideal starting point for Hugo Chat, which generates exactly the pages you describe.
</details>
<details>
<summary><b>Can I add any HugoBlox block?</b></summary>
Yes. The starter includes the full HugoBlox block library — hero, features, stats, testimonials, pricing, CTA, collection, and more. Assemble them in any combination.
</details>
<details>
<summary><b>Can I host for free?</b></summary>
Yes. GitHub Pages, Netlify, Vercel, and Cloudflare Pages all have free tiers for static sites. This template ships with GitHub Pages deployment pre-configured.
</details>
<details>
<summary><b>Can I migrate my content later?</b></summary>
Yes. Your site is just Markdown files in a folder. Copy them anywhere.
</details>
<details>
<summary><b>What's Hugo Chat?</b></summary>
An AI assistant that understands Hugo and HugoBlox. Describe what you want and it generates the right pages with correct front matter, blocks, and content. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_starter">Free to try.</a>
</details>
---
<h2 align="center">🚀 Ready to build?</h2>
<p align="center">
Deploy in 60 seconds. Build pages with AI. Own it as Markdown forever.
</p>
<p align="center">
<a href="https://hugoblox.com/templates/starter?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Starter — free</b></a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_starter"><b>Build with AI</b></a>
</p>
---
## Community & Support
- 💬 [**Discord**](https://discord.gg/z8wNYzb) — ask questions, share your site
- 📚 [**Docs**](https://docs.ownable.dev/?utm_source=github&utm_medium=readme&utm_content=community_starter)
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
- 🐦 [**Follow on X**](https://x.com/GoOwnable)
### Sponsors
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
---
Copyright 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme).
Released under the MIT License.
<p align="center">
<sub>HugoBlox is a trademark of Lore Labs.</sub>
</p>
Reference in new issue View Git Blame Copy Permalink