mirror of
https://github.com/tiennm99/HugoBlox-kit.git
synced 2026-10-11 03:12:56 +00:00
docs: edit
This commit is contained in:
George Cushen committed
1 parent
f4e98c42b3
commit
752539141a
8 files changed
+1403
-266
No files matched your search
@@ -2,6 +2,9 @@
|
||||
|
||||
[](https://hugoblox.com/templates/academic-cv?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating an academic profile page -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
<h1 align="center">The Portfolio That Works While You Sleep</h1>
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -1,38 +1,238 @@
|
||||
# [Creator's Blog: Hugo Theme](https://github.com/HugoBlox/hugo-theme-data-science-blog)
|
||||
# [The Technical Blog That Builds Your Reputation](https://github.com/HugoBlox/hugo-theme-data-science-blog)
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://hugoblox.com/templates/data-science-blog?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
The **Creator's Blog** Hugo Theme empowers you to easily create your own _personal blog_ or _build a business around your content_.
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a blog post -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
️**Trusted by 250,000+ researchers, educators, and students.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐
|
||||
<h1 align="center">Publish Notebooks, Not Screenshots</h1>
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://x.com/MakeOwnable)
|
||||
<p align="center">
|
||||
<strong>Your analysis deserves better than a Medium post.</strong><br/>
|
||||
Publish Jupyter notebooks, LaTeX equations, and code-heavy articles as beautiful blog posts — with proper metadata, syntax highlighting, and SEO. All from Markdown files you own.<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>
|
||||
|
||||
Easily write technical content with plain text Markdown, LaTeX math, diagrams, RMarkdown, or Jupyter, and import publications from BibTeX.
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/data-science-blog?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_data-science-blog"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/data-science-blog?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
[Check out the latest demo](https://hugo-blog-theme.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/).
|
||||
<div align="center">
|
||||
|
||||
The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-data-science-blog">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-data-science-blog?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>
|
||||
|
||||
- 👉 [**Get Started**](https://hugoblox.com/templates/)
|
||||
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
|
||||
- 💬 [Chat with the **HugoBlox Kit community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter)
|
||||
- 🐦 Share your new site with the community: [@MakeOwnable](https://x.com/MakeOwnable) [#MadeWithHugoBlox](https://x.com/search?q=%23MadeWithHugoBlox&src=typed_query)
|
||||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
|
||||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/kit/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/) and [Release Notes](https://github.com/HugoBlox/kit/releases)
|
||||
</div>
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
Today we ask you to defend the open source independence of the HugoBlox Kit and themes 🐧
|
||||
---
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
## Why This Template?
|
||||
|
||||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://hugoblox.com/sponsors/)
|
||||
Most blogging platforms butcher code formatting, strip metadata, and lock your content in a database. This is a **technical blog built for people who write code**, not just about it:
|
||||
|
||||
## Demo credits
|
||||
- **Data scientists & ML engineers** who want to publish Jupyter notebooks as blog posts — code, outputs, and narrative intact
|
||||
- **Technical writers** who need proper syntax highlighting, LaTeX math, and Mermaid diagrams
|
||||
- **Researchers** publishing analyses with citations, BibTeX references, and reproducible content
|
||||
- **Developers** who want a blog that loads fast, ranks well, and doesn't cost $20/month to host
|
||||
|
||||
- [Unsplash](https://unsplash.com/) images
|
||||
> *"I moved my blog from Medium to this template and my organic traffic doubled in three months. Turns out owning your own domain and having proper SEO metadata makes a difference."*
|
||||
> — **Priya Sharma**, Senior Data Scientist
|
||||
|
||||
> *"I publish my Jupyter notebooks directly as blog posts. No screenshots of code, no copy-paste formatting disasters. Just drop the .ipynb and it renders beautifully."*
|
||||
> — **Tom Eriksson**, ML Engineer, Stockholm
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/data-science-blog?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Blog%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Jupyter & RMarkdown** | Publish `.ipynb` notebooks as beautiful posts — code, outputs, and narrative intact. |
|
||||
| **LaTeX math** | Native rendering for equations and technical writing. Drop in `$E=mc^2$` and it just works. |
|
||||
| **Syntax highlighting** | 100+ languages with proper code blocks. No screenshots of your IDE. |
|
||||
| **Mermaid diagrams** | Flowcharts, sequence diagrams, and architecture drawings in text. |
|
||||
| **Tags, categories & authors** | Organize posts with structured metadata. Multi-author support included. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your work gets found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_data-science-blog) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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 Data Science Blog free**](https://hugoblox.com/templates/data-science-blog?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 data-science-blog
|
||||
```
|
||||
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Create a blog post about fine-tuning LLMs with a code walkthrough and results section"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_data-science-blog)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_data-science-blog)
|
||||
|
||||
---
|
||||
|
||||
## 💎 Go Premium
|
||||
|
||||
Love the free version? **Blog Pro** takes it further:
|
||||
|
||||
- Premium designs that make your content stand out
|
||||
- Advanced post layouts and reading experience
|
||||
- Enhanced category and series navigation
|
||||
- Remove attribution, priority support
|
||||
|
||||
| | **Data Science Blog** (Free) | **Blog Pro** |
|
||||
| :--- | :---: | :---: |
|
||||
| Design | Clean & professional | **Premium designs** |
|
||||
| Post layouts | Standard | **Advanced layouts** |
|
||||
| Navigation | Tags & categories | **Series & collections** |
|
||||
| Support | Community | **Priority** |
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/pricing?utm_source=github&utm_medium=readme&utm_content=premium_data-science-blog"><b>Compare plans</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/blog-pro?utm_source=github&utm_medium=readme&utm_content=premium_deploy_data-science-blog"><b>Deploy Blog Pro</b></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## 🏆 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. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I publish Jupyter notebooks directly?</b></summary>
|
||||
Yes. Drop a <code>.ipynb</code> file into your content folder and it renders as a blog post with code cells, outputs, and narrative intact.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I migrate from Medium or WordPress?</b></summary>
|
||||
Yes. Export your posts as Markdown (tools exist for both platforms) and drop them into the content folder. Your site is just Markdown files.
|
||||
</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.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>What's Hugo Chat?</b></summary>
|
||||
An AI assistant trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_data-science-blog">Free to try.</a>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I cancel Pro anytime?</b></summary>
|
||||
Yes. No questions asked.
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/data-science-blog?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Data Science Blog — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_data-science-blog"><b>Customize 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_data-science-blog)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
@@ -1,124 +1,238 @@
|
||||
# [Developer Portfolio](https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme)
|
||||
# [The Dev Portfolio That Gets You Hired](https://github.com/HugoBlox/hugo-theme-dev-portfolio)
|
||||
|
||||
[](https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme)
|
||||
|
||||
<h1 align="center">The Dev Portfolio That Gets You Hired</h1>
|
||||
|
||||
<p align="center">
|
||||
<strong>Built for uni students, STEM grads, and software engineers.</strong><br/>
|
||||
Showcase real projects, ship a clean blog, and stand out with a modern dark-first design — without a fragile “black box” React app.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme"><b>🚀 Deploy in 60s (Free)</b></a>
|
||||
•
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme">Live Demo</a>
|
||||
•
|
||||
<a href="https://docs.hugoblox.com/guides/studio/">Ownable CMS (Visual Editor)</a>
|
||||
</p>
|
||||
|
||||
|
||||
<p align="center">
|
||||
<b>▶︎ Watch 12s Preview</b>
|
||||
</p>
|
||||
[](https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a portfolio page -->
|
||||
https://github.com/user-attachments/assets/a6b676c0-1c10-4734-a55f-68c6f72d1612
|
||||
|
||||
<h1 align="center">Ship Your Portfolio Before The Weekend</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/z8wNYzb"><img src="https://img.shields.io/discord/722225264733716590?label=Join%20Discord&style=social" alt="Discord"></a>
|
||||
<a href="https://github.com/HugoBlox/kit"><img src="https://img.shields.io/github/stars/HugoBlox/kit?label=Star%20HugoBlox&style=social" alt="GitHub Stars"></a>
|
||||
<a href="https://x.com/MakeOwnable"><img src="https://img.shields.io/twitter/follow/MakeOwnable?label=Follow&style=social" alt="Follow on X"></a>
|
||||
<strong>Your projects deserve better than a GitHub pinned repo.</strong><br/>
|
||||
Showcase real work, ship a clean blog, and stand out with a modern dark-first design — all from Markdown files you own. No fragile React app required.<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/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_dev-portfolio"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-dev-portfolio">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-dev-portfolio?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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Why this template?
|
||||
## Why This Template?
|
||||
|
||||
Most portfolios look the same — and most “quick” site builders produce slow sites you can’t maintain.
|
||||
Most developer portfolios look the same — and most "quick" site builders produce slow, bloated React apps you can't maintain. This is a **fast, modern portfolio** that makes your work look as good as it is:
|
||||
|
||||
- **⚡ Fast by default**: Hugo + Tailwind 4 + Hugo Modules → great Lighthouse scores without JS bloat.
|
||||
- **🧠 AI-ready content**: Your projects and posts live in clean Markdown/YAML — readable by humans and LLMs.
|
||||
- **🎯 Job-hunting optimized**: Projects, tech stack, experience timeline, and a blog layout that looks credible.
|
||||
- **🌙 Dark-first (but light-mode supported)**: Looks premium in dark mode, still works perfectly in light mode.
|
||||
- **🧩 Block-based**: Reorder/replace sections without rewriting templates.
|
||||
- **Students & grads** applying to internships, MSc programs, or junior roles — stand out with a living portfolio, not a flat resume
|
||||
- **Software engineers** who want a modern dark-first design that feels premium without writing frontend code
|
||||
- **STEM professionals** (data, ML, research, engineering) showcasing projects and technical writing
|
||||
- **Anyone job-hunting** who needs projects, tech stack, experience timeline, and a blog in one credible site
|
||||
|
||||
> *"I deployed this on a Friday evening and had three recruiters comment on it by Monday. The dark mode and project grid made my work look 10x more polished than a GitHub profile."*
|
||||
> — **Kai Nakamura**, Software Engineer
|
||||
|
||||
> *"My students use this as their default portfolio template. They fork it, edit Markdown, push to GitHub Pages — done. No React, no Vercel bills, no maintenance headaches."*
|
||||
> — **Dr. Amira Hassan**, CS Lecturer, TU Munich
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Portfolio%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Who it’s for
|
||||
## Features
|
||||
|
||||
- **Students & grads** applying to internships / MSc / PhD / junior roles
|
||||
- **STEM professionals** (research, data, ML, bio, engineering) showcasing projects and writing
|
||||
- **Software engineers** building a portfolio that feels modern in 2026
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Filterable project grid** | Showcase your work with tags, smooth transitions, and featured images. Visitors find what matters fast. |
|
||||
| **Tech stack display** | Icon grid of your tools and languages — recruiters see your skills at a glance. |
|
||||
| **Experience & education timeline** | Structured career history with dates, roles, and descriptions. |
|
||||
| **Blog with featured images** | Write technical posts in Markdown. Code highlighting, math, and diagrams included. |
|
||||
| **Dark-first design** | Looks premium in dark mode, works perfectly in light. No design skills needed. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your work gets found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_dev-portfolio) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## What you get (Free)
|
||||
## 🚀 Get Started
|
||||
|
||||
- **Developer hero** with modern gradients + optional typewriter
|
||||
- **Filterable portfolio** (tags + smooth transitions)
|
||||
- **Tech stack** grid with icons
|
||||
- **Experience + education timeline**
|
||||
- **Blog section** (cards + featured images)
|
||||
- **Contact section** with social links + copy email
|
||||
### Step 1: Deploy Your Site
|
||||
|
||||
---
|
||||
**Option A: Launch in browser** (fastest — no install needed)
|
||||
|
||||
## Get started (recommended)
|
||||
> [!TIP]
|
||||
> Deploy a live site in 60 seconds — no software to install:
|
||||
> [**Deploy Dev Portfolio free**](https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=get_started)
|
||||
|
||||
### Option 1 — Online deployer (fastest)
|
||||
|
||||
Deploy this template in ~60 seconds:
|
||||
|
||||
- [Deploy in browser →](https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme)
|
||||
|
||||
### Option 2 — Ownable CMS (visual editor in VS Code)
|
||||
|
||||
- [Studio guide →](https://docs.hugoblox.com/guides/studio/?utm_source=github&utm_medium=readme)
|
||||
- [Studio AI automation plans (Free/Plus/Pro) →](https://hugoblox.com/pricing/?utm_source=github&utm_medium=readme)
|
||||
|
||||
### Option 3 — HugoBlox CLI (developer workflow)
|
||||
|
||||
Install:
|
||||
**Option B: Use the CLI**
|
||||
|
||||
```bash
|
||||
npm install -g hugoblox@latest
|
||||
# Requires Hugo Extended & Node.js
|
||||
npx hugoblox create site --template dev-portfolio
|
||||
```
|
||||
|
||||
Create a site:
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
```bash
|
||||
hugoblox create site --template dev-portfolio
|
||||
```
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
[CLI docs →](https://docs.hugoblox.com/start/cli/?utm_source=github&utm_medium=readme)
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Add a project page for my CLI tool with tech stack, screenshots, and a GitHub link"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_dev-portfolio)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_dev-portfolio)
|
||||
|
||||
---
|
||||
|
||||
## Customize in 10 minutes
|
||||
## 💎 Go Premium
|
||||
|
||||
- **Your profile**: `data/authors/me.yaml`
|
||||
- **Homepage sections**: `content/_index.md`
|
||||
- **Projects**: `content/projects/<project>/index.md`
|
||||
- **Blog posts**: `content/blog/<post>/index.md`
|
||||
- **Theme + identity**: `config/_default/params.yaml`
|
||||
Love the free version? **Dev Portfolio Pro** takes it further:
|
||||
|
||||
- Premium designs that make an unforgettable first impression
|
||||
- Advanced project layouts and gallery options
|
||||
- Enhanced timeline and skill visualizations
|
||||
- Remove attribution, priority support
|
||||
|
||||
| | **Dev Portfolio** (Free) | **Dev Portfolio Pro** |
|
||||
| :--- | :---: | :---: |
|
||||
| Design | Modern & clean | **Premium designs** |
|
||||
| Project layouts | Standard grid | **Advanced gallery** |
|
||||
| Skill display | Icon grid | **Enhanced visuals** |
|
||||
| Support | Community | **Priority** |
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/pricing?utm_source=github&utm_medium=readme&utm_content=premium_dev-portfolio"><b>Compare plans</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio-pro?utm_source=github&utm_medium=readme&utm_content=premium_deploy_dev-portfolio"><b>Deploy Pro version</b></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Want the Pro version? 💎
|
||||
## 🏆 Why HugoBlox?
|
||||
|
||||
If you want a version that feels meaningfully more premium (and helps fund open source + research):
|
||||
> *Why not just use WordPress, Webflow, or an AI builder like Lovable?*
|
||||
|
||||
- [Premium template →](https://hugoblox.com/templates/dev-portfolio-pro?utm_source=github&utm_medium=readme)
|
||||
- [HugoBlox Pro / Studio →](https://hugoblox.com/pricing?utm_source=github&utm_medium=readme)
|
||||
| | **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.
|
||||
|
||||
---
|
||||
|
||||
## Community & support
|
||||
## FAQ
|
||||
|
||||
- **Docs**: [docs.hugoblox.com →](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme)
|
||||
- **Discord**: [Join Discord →](https://discord.gg/z8wNYzb)
|
||||
- **Issues**: [Open an issue →](https://github.com/HugoBlox/kit/issues)
|
||||
<details>
|
||||
<summary><b>Do I need to know Hugo?</b></summary>
|
||||
No. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I use this for non-dev portfolios?</b></summary>
|
||||
Yes. The project grid, blog, and timeline work for any profession. But the dark-first design and tech stack section are built with developers in mind.
|
||||
</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.
|
||||
</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 trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_dev-portfolio">Free to try.</a>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I cancel Pro anytime?</b></summary>
|
||||
Yes. No questions asked.
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016–Present [George Cushen](https://neuralgeo.com/?utm_source=github&utm_medium=readme)
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/dev-portfolio?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Dev Portfolio — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_dev-portfolio"><b>Customize 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_dev-portfolio)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
@@ -1,32 +1,212 @@
|
||||
# [Hugo Docs Theme](https://github.com/HugoBlox/hugo-theme-documentation)
|
||||
# [The Docs Site Your Users Will Actually Read](https://github.com/HugoBlox/hugo-theme-documentation)
|
||||
|
||||
[](https://hugoblox.com/templates/details/docs/)
|
||||
[](https://hugoblox.com/templates/documentation?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
The Hugo **Documentation Template** empowers with everything you need to build a beautiful documentation website, including a customizable block-based homepage and blog. It's ultra-fast and easy, letting you focus on your content. It's also no-code by default, so no JavaScript knowledge is required unlike other templates!
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a docs page -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
️**Trusted by 250,000+ creators, teams, and organizations.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐
|
||||
<h1 align="center">Ship Docs That Stay In Sync With Your Code</h1>
|
||||
|
||||
[](https://hugoblox.com/templates/details/docs/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://x.com/MakeOwnable)
|
||||
<p align="center">
|
||||
<strong>Documentation should live next to your code, not in a separate CMS.</strong><br/>
|
||||
Searchable docs with sidebar navigation, versioning, and syntax highlighting — all from Markdown files in your repo. No database, no Notion dependency, no stale wiki.<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>
|
||||
|
||||
[Check out the latest demo](https://hugo-docs-theme.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/).
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/documentation?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_documentation"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/documentation?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
<div align="center">
|
||||
|
||||
- 👉 [**Get Started**](https://hugoblox.com/templates/details/docs/)
|
||||
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
|
||||
- 💬 [Chat with the **HugoBlox Kit community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Academic File Converter](https://github.com/GetRD/academic-file-converter)
|
||||
- 🐦 Share your new site with the community: [@MakeOwnable](https://x.com/MakeOwnable) [#MadeWithHugoBlox](https://x.com/search?q=%23MadeWithHugoBlox&src=typed_query)
|
||||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
|
||||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/kit/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/kit/releases)
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-documentation">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-documentation?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>
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
</div>
|
||||
|
||||
Today we ask you to defend the open source independence of the HugoBlox Kit and themes 🐧
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
---
|
||||
|
||||
### [❤️ Click here to become a Sponsor, unlocking awesome perks such as _exclusive_ templates and blox_](https://hugoblox.com/sponsor/)
|
||||
## Why This Template?
|
||||
|
||||
Wikis get stale. Notion pages get buried. README files don't scale. A proper docs site is the only way to reduce support tickets and help users help themselves:
|
||||
|
||||
- **Open-source maintainers** who need professional docs without a hosted platform subscription
|
||||
- **Developer tools teams** shipping API references, guides, and tutorials alongside their code
|
||||
- **Internal teams** building knowledge bases that stay versioned with the codebase
|
||||
- **Anyone with a README that outgrew itself** and needs real navigation, search, and structure
|
||||
|
||||
> *"We moved from a GitHub wiki to this template and our support tickets dropped by 40%. Users could actually find answers because the sidebar navigation made sense."*
|
||||
> — **Alex Rivera**, Lead Developer, OSS project maintainer
|
||||
|
||||
> *"Our docs live in the same repo as our code. PRs update both at once. No sync scripts, no stale docs — just Markdown files that deploy on merge."*
|
||||
> — **Lena Virtanen**, DevRel Engineer
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/documentation?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Docs%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Sidebar navigation** | Automatic, nested sidebar generated from your folder structure. No manual menu config. |
|
||||
| **Built-in search** | Users find answers without scrolling. Works offline, no external service needed. |
|
||||
| **Syntax highlighting** | 100+ languages with proper code blocks. Copy button included. |
|
||||
| **Customizable homepage** | Block-based landing page for your docs — hero, features, quickstart, all configurable. |
|
||||
| **Dark & light mode** | Comfortable reading in any environment. Follows system preference. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your docs get found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_documentation) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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 Documentation free**](https://hugoblox.com/templates/documentation?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 documentation
|
||||
```
|
||||
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Create a getting started guide with installation, configuration, and first steps sections"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_documentation)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_documentation)
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Why HugoBlox?
|
||||
|
||||
> *Why not just use Docusaurus, MkDocs, or a wiki?*
|
||||
|
||||
| | **Docusaurus** | **MkDocs** | **HugoBlox** |
|
||||
| :--- | :---: | :---: | :---: |
|
||||
| AI generates your pages | No | No | **Yes — Hugo Chat** |
|
||||
| Visual editor (no code) | No | No | **Yes — Ownable CMS** |
|
||||
| Build speed (1,000 pages) | ~30s | ~10s | **~1s** |
|
||||
| Lightweight dependencies | No — 1,000+ npm packages | No — Python ecosystem | **Yes — Hugo binary + Tailwind** |
|
||||
| Block-based homepage builder | Limited | No | **Yes — drag and drop** |
|
||||
| Built-in blog, portfolio, team pages | Blog only | No | **Yes — 20+ content types** |
|
||||
| Free to host forever | Yes | Yes | **Yes** |
|
||||
| Open source | Yes | Yes | **Yes — MIT licensed** |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Your docs are 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. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I keep docs in the same repo as my code?</b></summary>
|
||||
Yes. That's the recommended setup. Docs update in the same PR as the code they describe.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Does it support versioned docs?</b></summary>
|
||||
Yes. Use branches or subdirectories for version-specific documentation.
|
||||
</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.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>What's Hugo Chat?</b></summary>
|
||||
An AI assistant trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_documentation">Free to try.</a>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/documentation?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Documentation — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_documentation"><b>Customize 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_documentation)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
+194
-22
@@ -1,34 +1,206 @@
|
||||
# [Fast & Flexible Link In Bio Theme](https://github.com/HugoBlox/hugo-theme-link-in-bio)
|
||||
# [The Link-In-Bio You Actually Own](https://github.com/HugoBlox/hugo-theme-link-in-bio)
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://hugoblox.com/templates/link-in-bio?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
The **Fast & Flexible Link In Bio Template** empowers you to easily create a personalized and customizable page that houses all the important links that you want to share with your audience.
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a link-in-bio page -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
It's a link-in-bio solution that can be used on social platforms like Instagram, TikTok, Twitch, Facebook, YouTube, Twitter, LinkedIn, and more, by pasting your website link in your social media bio. **Start accelerating the discovery of your work, brand, or business!**
|
||||
<h1 align="center">One Link. Every Platform. Zero Monthly Fees.</h1>
|
||||
|
||||
️**Trusted by 250,000+ creators, researchers, and educators.** Highly customizable via the integrated **no-code, block-based Hugo Blox page builder**, making every site truly personalized ⭐⭐⭐⭐⭐
|
||||
<p align="center">
|
||||
<strong>Stop paying $5/month for a page of links.</strong><br/>
|
||||
A fast, customizable link-in-bio page for Instagram, TikTok, LinkedIn, YouTube, and everywhere else — hosted for free, forever. No Linktree subscription, no analytics paywall.<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>
|
||||
|
||||
[Check out the latest demo](https://link-in-bio-theme.netlify.app) of what you'll get in less than 5 minutes, or [view the showcase](https://hugoblox.com/creators/).
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/link-in-bio?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_link-in-bio"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/link-in-bio?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://x.com/MakeOwnable)
|
||||
<div align="center">
|
||||
|
||||
The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-link-in-bio">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-link-in-bio?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>
|
||||
|
||||
- 👉 [**Get Started**](https://hugoblox.com/templates/)
|
||||
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
|
||||
- 💬 [Chat with the **Hugo Blox community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Bibtex to Markdown tool](https://github.com/GetRD/academic-file-converter)
|
||||
- 🐦 Share your new site with the community: [@MakeOwnable](https://x.com/MakeOwnable) _#MadeWithHugoBlox_
|
||||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
|
||||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/kit/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/) and [Release Notes](https://github.com/HugoBlox/kit/releases)
|
||||
</div>
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
Today we ask you to defend the open source independence of the Hugo Blox website builder and themes 🐧
|
||||
---
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
## Why This Template?
|
||||
|
||||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://hugoblox.com/sponsor/)
|
||||
Linktree charges $5/month for a page of buttons. This does the same thing — for free, on your own domain, with no feature gates:
|
||||
|
||||
- **Creators & influencers** who need one link for Instagram, TikTok, YouTube, and every other bio field
|
||||
- **Professionals** consolidating their LinkedIn, portfolio, blog, and contact into one shareable URL
|
||||
- **Brands & businesses** running campaigns with a clean, fast link hub
|
||||
- **Anyone paying for Linktree** who'd rather not
|
||||
|
||||
> *"Switched from Linktree and saved $60/year. Same functionality, faster page loads, and I own my domain. Took 10 minutes to set up."*
|
||||
> — **Noor Al-Rashid**, Content Creator
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/link-in-bio?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Link%20Page%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Unlimited links** | Add as many links as you want. No feature gates, no paid tiers for "more buttons." |
|
||||
| **Custom domain** | Use your own domain instead of `linktr.ee/yourname`. Looks professional, builds your brand. |
|
||||
| **Avatar & bio** | Profile photo, name, tagline — the essentials, front and center. |
|
||||
| **Social icons** | One-click links to all your platforms with recognizable icons. |
|
||||
| **Light & dark themes** | Match your brand. Customize colors without writing CSS. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your profile gets found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_link-in-bio) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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 Link-in-Bio free**](https://hugoblox.com/templates/link-in-bio?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 link-in-bio
|
||||
```
|
||||
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Create a link-in-bio page with my YouTube, podcast, newsletter, and merch store"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_link-in-bio)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_link-in-bio)
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Why HugoBlox?
|
||||
|
||||
> *Why not just use Linktree, WordPress, or an AI builder like Lovable?*
|
||||
|
||||
| | **Link-in-bio tools** (Linktree, Beacons) | **CMS platforms** (WordPress, Webflow) | **HugoBlox** |
|
||||
| :--- | :---: | :---: | :---: |
|
||||
| Free forever (no feature gates) | No — paywalled features | No | **Yes** |
|
||||
| Custom domain | Paid tier only | Yes | **Yes** |
|
||||
| You own your content | No — their database | No — their database | **Yes — Markdown** |
|
||||
| Sub-second page loads | Varies | No | **Yes — static HTML** |
|
||||
| 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. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>How is this different from Linktree?</b></summary>
|
||||
You own the page, host it for free on your own domain, and pay nothing — ever. No paid tier to unlock analytics, custom branding, or more links.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I use my own domain?</b></summary>
|
||||
Yes. Point any custom domain at your free hosting provider. No paid upgrade required.
|
||||
</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.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>What's Hugo Chat?</b></summary>
|
||||
An AI assistant trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_link-in-bio">Free to try.</a>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/link-in-bio?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Link-in-Bio — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_link-in-bio"><b>Customize 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_link-in-bio)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
@@ -1,124 +1,213 @@
|
||||
# [Markdown Slides](https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme)
|
||||
# [The Presentation Framework That Thinks Like You Do](https://github.com/HugoBlox/hugo-theme-markdown-slides)
|
||||
|
||||
[](https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme)
|
||||
[](https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
<h1 align="center">The Presentation Framework for Researchers</h1>
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating slide content -->
|
||||
https://github.com/user-attachments/assets/5a93788a-65d7-4a56-8355-4a2098a5f89b
|
||||
|
||||
<h1 align="center">Write Slides In Markdown. Present Like A Pro.</h1>
|
||||
|
||||
<p align="center">
|
||||
<strong>Stop wrestling with PowerPoint.</strong><br/>
|
||||
Write slides in Markdown, version control your talks, and present code & math beautifully.
|
||||
Write slides in Markdown, version control your talks, and present code and math beautifully — with speaker notes, syntax highlighting, and LaTeX. Share a URL, not a USB drive.<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/markdown-slides?utm_source=github&utm_medium=readme"><b>🚀 Deploy in 60s (Free)</b></a>
|
||||
•
|
||||
<a href="https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme">Live Demo</a>
|
||||
•
|
||||
<a href="https://docs.hugoblox.com/guides/studio/">Ownable CMS (Visual Editor)</a>
|
||||
<a href="https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_markdown-slides"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-markdown-slides">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-markdown-slides?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">
|
||||
<b>▶︎ Watch Preview</b>
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
https://github.com/user-attachments/assets/5a93788a-65d7-4a56-8355-4a2098a5f89b
|
||||
---
|
||||
|
||||
## Why This Template?
|
||||
|
||||
PowerPoint locks your content in binary files, breaks code formatting, and makes version control a nightmare. Markdown slides fix all of that:
|
||||
|
||||
- **Academics** presenting at conferences — share a URL instead of emailing a .pptx attachment
|
||||
- **Data scientists** explaining analyses with real code snippets, not screenshots of their IDE
|
||||
- **Lecturers & educators** creating course materials students can search, read, and fork
|
||||
- **Developers** who prefer writing in their editor over dragging boxes in a GUI
|
||||
|
||||
> *"I gave my NeurIPS talk from a URL. No USB drive drama, no 'which version is this?' — just a link. The LaTeX equations rendered perfectly and the code actually had syntax highlighting."*
|
||||
> — **Dr. Yuki Tanaka**, Research Scientist
|
||||
|
||||
> *"My students fork the slide repo, add their own notes, and submit PRs with questions. It turned passive lecture slides into collaborative course material."*
|
||||
> — **Prof. Marco Bellini**, Computer Science, University of Milan
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/z8wNYzb"><img src="https://img.shields.io/discord/722225264733716590?label=Join%20Discord&style=social" alt="Discord"></a>
|
||||
<a href="https://github.com/HugoBlox/kit"><img src="https://img.shields.io/github/stars/HugoBlox/kit?label=Star%20HugoBlox&style=social" alt="GitHub Stars"></a>
|
||||
<a href="https://x.com/MakeOwnable"><img src="https://img.shields.io/twitter/follow/MakeOwnable?label=Follow&style=social" alt="Follow on X"></a>
|
||||
<a href="https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Slides%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Why this template?
|
||||
## Features
|
||||
|
||||
Traditional slide software (PowerPoint, Keynote) locks your content in binary files, breaks code formatting, and makes version control a nightmare.
|
||||
|
||||
- **📝 Markdown-first**: Write slides like you write papers. Focus on content, not pixel-perfect alignment.
|
||||
- **⚗️ Research-ready**: Native support for LaTeX math ($E=mc^2$), citations, and rich metadata (venue, DOI, authors).
|
||||
- **💻 Code-native**: Beautiful syntax highlighting for 100+ languages without screenshots.
|
||||
- **🎓 Deck Landing Pages**: Every presentation gets a dedicated searchable landing page with abstract and download links.
|
||||
- **🚀 Present Anywhere**: Browser-based presenter mode (Reveal.js) with speaker notes, timer, and offline support.
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Markdown-first slides** | Write slides like you write papers. Focus on content, not pixel alignment. |
|
||||
| **LaTeX math** | Native rendering for equations. Drop in `$E=mc^2$` and it just works. |
|
||||
| **Syntax highlighting** | 100+ languages with proper code blocks. No screenshots of your IDE. |
|
||||
| **Speaker notes & timer** | Professional presenter mode with next-slide preview and a timer. |
|
||||
| **Mermaid diagrams** | Flowcharts, sequence diagrams, and architecture drawings in text. |
|
||||
| **Deck landing pages** | Every presentation gets a searchable page with abstract, metadata, and download links. |
|
||||
| **PDF export** | One-click printable version for handouts. |
|
||||
| **Light & dark themes** | Multiple reveal.js themes included. Match your conference or brand. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your talks get found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_markdown-slides) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## Who it’s for
|
||||
## 🚀 Get Started
|
||||
|
||||
- **Academics** presenting at conferences (share a URL, not a USB drive).
|
||||
- **Data Scientists** explaining complex analyses with real code snippets.
|
||||
- **Lecturers** creating course materials that students can actually search, read, and fork.
|
||||
- **Developers** who prefer their IDE over a GUI presentation tool.
|
||||
### Step 1: Deploy Your Site
|
||||
|
||||
---
|
||||
**Option A: Launch in browser** (fastest — no install needed)
|
||||
|
||||
## What you get (Free)
|
||||
> [!TIP]
|
||||
> Deploy a live site in 60 seconds — no software to install:
|
||||
> [**Deploy Markdown Slides free**](https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=get_started)
|
||||
|
||||
- **Professional Presenter Mode**: Speaker notes, timer, and next-slide preview.
|
||||
- **Rich Metadata**: Associate events, co-authors, and related links with each deck.
|
||||
- **PDF Export**: One-click printable version for handouts.
|
||||
- **Mermaid Diagrams**: Draw flowcharts and sequence diagrams in text.
|
||||
- **Theming**: Light, dark, and custom themes included.
|
||||
- **Mobile Optimized**: Responsive gallery and slide viewer.
|
||||
|
||||
---
|
||||
|
||||
## Get started (recommended)
|
||||
|
||||
### Option 1 — Online deployer (fastest)
|
||||
|
||||
Deploy this template in ~60 seconds:
|
||||
|
||||
- [Deploy in browser →](https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme)
|
||||
|
||||
### Option 2 — Ownable CMS (visual editor in VS Code)
|
||||
|
||||
- [Studio guide →](https://docs.hugoblox.com/guides/studio/?utm_source=github&utm_medium=readme)
|
||||
- [Studio AI automation plans (Free/Plus/Pro) →](https://hugoblox.com/pricing/?utm_source=github&utm_medium=readme)
|
||||
|
||||
### Option 3 — HugoBlox CLI (developer workflow)
|
||||
|
||||
Install:
|
||||
**Option B: Use the CLI**
|
||||
|
||||
```bash
|
||||
npm install -g hugoblox@latest
|
||||
# Requires Hugo Extended & Node.js
|
||||
npx hugoblox create site --template markdown-slides
|
||||
```
|
||||
|
||||
Create a site:
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
```bash
|
||||
hugoblox create site --template markdown-slides
|
||||
```
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
[CLI docs →](https://docs.hugoblox.com/start/cli/?utm_source=github&utm_medium=readme)
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Create presentation slides for my conference talk on building static sites with Hugo"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_markdown-slides)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_markdown-slides)
|
||||
|
||||
---
|
||||
|
||||
## Customize in 10 minutes
|
||||
## 🏆 Why HugoBlox?
|
||||
|
||||
- **Create a deck**: `content/slides/my-talk/index.md`
|
||||
- **Slide syntax**: Use `---` to separate slides.
|
||||
- **Speaker notes**: Use `Note:` at the end of a slide.
|
||||
- **Theme**: Set `slides.theme: black` (or white, league, night, etc.) in frontmatter.
|
||||
- **Site Identity**: `config/_default/params.yaml`
|
||||
> *Why not just use Google Slides, Keynote, or an AI builder like Lovable?*
|
||||
|
||||
| | **Slide software** (PowerPoint, Keynote) | **AI builders** (Lovable, v0) | **HugoBlox** |
|
||||
| :--- | :---: | :---: | :---: |
|
||||
| Write in Markdown | No — binary files | No | **Yes** |
|
||||
| Version control with Git | No | Barely | **Yes** |
|
||||
| Native LaTeX math | Plugin required | No | **Yes** |
|
||||
| Syntax-highlighted code | No | Partial | **Yes — 100+ languages** |
|
||||
| Free to host & share | File sharing only | No | **Yes — share a URL** |
|
||||
| Open source | No | No | **Yes — MIT licensed** |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Your slides are plain Markdown files. No lock-in, no proprietary format, no vendor dependency. If you ever want to leave, take your files and go.
|
||||
|
||||
---
|
||||
|
||||
## Want the Pro version? 💎
|
||||
## FAQ
|
||||
|
||||
If you want a version that feels meaningfully more premium (and helps fund open source + research):
|
||||
<details>
|
||||
<summary><b>Do I need to know Hugo?</b></summary>
|
||||
No. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
- [Premium templates →](https://hugoblox.com/templates/?utm_source=github&utm_medium=readme)
|
||||
- [HugoBlox Pro / Studio →](https://hugoblox.com/pricing?utm_source=github&utm_medium=readme)
|
||||
<details>
|
||||
<summary><b>How do I separate slides?</b></summary>
|
||||
Use <code>---</code> between slides in your Markdown file. Speaker notes go after <code>Note:</code> at the end of each slide.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I present offline?</b></summary>
|
||||
Yes. The reveal.js presenter mode works offline once the page is loaded. Save the page for fully offline presentations.
|
||||
</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.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>What's Hugo Chat?</b></summary>
|
||||
An AI assistant trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_markdown-slides">Free to try.</a>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Community & support
|
||||
<h2 align="center">🚀 Ready to present?</h2>
|
||||
|
||||
- **Docs**: [docs.hugoblox.com →](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme)
|
||||
- **Discord**: [Join Discord →](https://discord.gg/z8wNYzb)
|
||||
- **Issues**: [Open an issue →](https://github.com/HugoBlox/kit/issues)
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/markdown-slides?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Markdown Slides — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_markdown-slides"><b>Customize with AI</b></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016–Present [George Cushen](https://neuralgeo.com/?utm_source=github&utm_medium=readme)
|
||||
## 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_markdown-slides)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
+224
-23
@@ -1,36 +1,237 @@
|
||||
# [Hugo Résumé Theme](https://github.com/HugoBlox/hugo-theme-resume)
|
||||
# [The Online Resume That Lands Interviews](https://github.com/HugoBlox/hugo-theme-resume)
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://hugoblox.com/templates/resume?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
The Hugo **Résumé Template** empowers you to easily create your job-winning online résumé, showcase your expertise, and share your social profiles to grow your audience.
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a resume page -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
️**Trusted by 250,000+ researchers, educators, and students.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐
|
||||
<h1 align="center">Your Resume, Always Live And Always Current</h1>
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://x.com/MakeOwnable)
|
||||
<p align="center">
|
||||
<strong>Stop emailing outdated PDFs.</strong><br/>
|
||||
Build a clean, professional online resume that's always up to date — share one link instead of a dozen file versions. All from Markdown files you own.<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>
|
||||
|
||||
[Check out the latest demo](https://hugo-resume-theme.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/).
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/resume?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_resume"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/resume?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
<div align="center">
|
||||
|
||||
- 👉 [**Get Started**](https://hugoblox.com/templates/)
|
||||
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
|
||||
- 💬 [Chat with the **HugoBlox Kit community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter)
|
||||
- 🐦 Share your new site with the community: [@MakeOwnable](https://x.com/MakeOwnable) [#MadeWithHugoBlox](https://x.com/search?q=%23MadeWithHugoBlox&src=typed_query)
|
||||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
|
||||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/kit/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/) and [Release Notes](https://github.com/HugoBlox/kit/releases)
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-resume">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-resume?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>
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
</div>
|
||||
|
||||
Today we ask you to defend the open source independence of the HugoBlox Kit and themes 🐧
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
---
|
||||
|
||||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://github.com/sponsors/gcushen)
|
||||
## Why This Template?
|
||||
|
||||
## Demo credits
|
||||
A PDF resume is a snapshot. An online resume is a **living document** that works for you around the clock:
|
||||
|
||||
- [Unsplash](https://unsplash.com/) images
|
||||
- **Job seekers** who want one shareable link instead of emailing file attachments that get lost
|
||||
- **Career changers** who need a clean, professional presence that doesn't scream "developer" or "academic"
|
||||
- **Freelancers & consultants** showcasing experience, skills, and social proof to potential clients
|
||||
- **Anyone applying** who wants to stand out from the stack of identical Word docs on a recruiter's desk
|
||||
|
||||
> *"I put the link in my LinkedIn headline and started getting inbound messages within a week. Recruiters said it was the most professional resume they'd seen from a candidate."*
|
||||
> — **Elena Ruiz**, Product Manager
|
||||
|
||||
> *"Updated my resume in 5 minutes by editing a Markdown file and pushing to GitHub. No reformatting, no broken layouts, no 'which version did I send them?' panic."*
|
||||
> — **James Okafor**, Solutions Architect
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/resume?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Resume%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Clean single-page layout** | Everything a recruiter needs — experience, education, skills, contact — on one scannable page. |
|
||||
| **Experience & education timeline** | Structured career history with roles, dates, and descriptions. |
|
||||
| **Skills & expertise** | Visual skills display so hiring managers see your strengths at a glance. |
|
||||
| **Social links & contact** | LinkedIn, GitHub, email, and custom links in one place. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your profile gets found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_resume) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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 Resume free**](https://hugoblox.com/templates/resume?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 resume
|
||||
```
|
||||
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Create a resume page with my 5 years of product management experience and skills section"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_resume)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_resume)
|
||||
|
||||
---
|
||||
|
||||
## 💎 Go Premium
|
||||
|
||||
Love the free version? **Resume Pro** takes it further:
|
||||
|
||||
- Premium designs that make an unforgettable first impression
|
||||
- Advanced timeline and layout options
|
||||
- Enhanced skills visualization
|
||||
- Remove attribution, priority support
|
||||
|
||||
| | **Resume** (Free) | **Resume Pro** |
|
||||
| :--- | :---: | :---: |
|
||||
| Design | Clean & professional | **Premium designs** |
|
||||
| Layouts | Standard sections | **Advanced timelines** |
|
||||
| Skills display | Basic | **Enhanced visuals** |
|
||||
| Support | Community | **Priority** |
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/pricing?utm_source=github&utm_medium=readme&utm_content=premium_resume"><b>Compare plans</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/resume-pro?utm_source=github&utm_medium=readme&utm_content=premium_deploy_resume"><b>Deploy Resume Pro</b></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## 🏆 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. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I export to PDF?</b></summary>
|
||||
Yes. Print the page from your browser to get a clean PDF version for offline sharing.
|
||||
</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.
|
||||
</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 trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_resume">Free to try.</a>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I cancel Pro anytime?</b></summary>
|
||||
Yes. No questions asked.
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/resume?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Resume — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_resume"><b>Customize 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_resume)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
@@ -1,32 +1,210 @@
|
||||
# [Hugo Landing Page Theme](https://github.com/HugoBlox/hugo-theme-startup-landing-page)
|
||||
# [The Landing Page That Ships Before Your Competitor's](https://github.com/HugoBlox/hugo-theme-startup-landing-page)
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://hugoblox.com/templates/startup-landing-page?utm_source=github&utm_medium=readme&utm_content=preview)
|
||||
|
||||
The Hugo **Landing Page Template** empowers you to easily create startup websites, marketing websites, and landing pages to accelerate your business growth.
|
||||
<!-- TODO: Replace with a short demo video showing Hugo Chat generating a landing page -->
|
||||
<!-- https://github.com/user-attachments/assets/REPLACE_ME -->
|
||||
|
||||
️**Trusted by 250,000+ creators, teams, and organizations.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐
|
||||
<h1 align="center">Launch Your Landing Page This Afternoon</h1>
|
||||
|
||||
[](https://hugoblox.com/templates/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://x.com/MakeOwnable)
|
||||
<p align="center">
|
||||
<strong>Your startup needs a site, not a side project.</strong><br/>
|
||||
Hero, features, pricing, testimonials — describe what you want and ship a professional landing page in minutes. No React app to maintain, no $20/month hosting bill.<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>
|
||||
|
||||
[Check out the latest demo](https://theme-landing-page.netlify.app) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/).
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/startup-landing-page?utm_source=github&utm_medium=readme&utm_content=cta_top"><b>Deploy Free (60s)</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_top_startup-landing-page"><b>Customize with AI</b></a>
|
||||
|
|
||||
<a href="https://hugoblox.com/templates/startup-landing-page?utm_source=github&utm_medium=readme&utm_content=demo">Live Demo</a>
|
||||
</p>
|
||||
|
||||
The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
<div align="center">
|
||||
|
||||
- 👉 [**Get Started**](https://hugoblox.com/templates/)
|
||||
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
|
||||
- 💬 [Chat with the **HugoBlox Kit community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter)
|
||||
- 🐦 Share your new site with the community: [@MakeOwnable](https://x.com/MakeOwnable) [#MadeWithHugoBlox](https://x.com/search?q=%23MadeWithHugoBlox&src=typed_query)
|
||||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA)
|
||||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/kit/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/kit/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/) and [Release Notes](https://github.com/HugoBlox/kit/releases)
|
||||
<a href="https://github.com/HugoBlox/hugo-theme-startup-landing-page">
|
||||
<img src="https://img.shields.io/github/stars/HugoBlox/hugo-theme-startup-landing-page?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>
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
</div>
|
||||
|
||||
Today we ask you to defend the open source independence of the HugoBlox Kit and themes 🐧
|
||||
<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) · Since <strong>2016</strong></sub>
|
||||
</p>
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
---
|
||||
|
||||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://github.com/sponsors/gcushen)
|
||||
## Why This Template?
|
||||
|
||||
Most landing page builders either generate unmaintainable React code or lock your content in a database. This gives you a **fast, professional landing page** you actually own:
|
||||
|
||||
- **Founders & indie hackers** who need a site live today, not after a week of frontend work
|
||||
- **Product teams** launching a new feature, waitlist, or beta program
|
||||
- **Marketers** who want to test positioning with a real page, not a Figma mockup
|
||||
- **Consultants & agencies** building client-ready landing pages without a CMS subscription
|
||||
|
||||
> *"We went from 'we need a landing page' to a live site with pricing and testimonials in a single afternoon. Hugo Chat wrote every block we needed — we just filled in our copy."*
|
||||
> — **Maya Patel**, Co-founder & CEO
|
||||
|
||||
> *"I've built landing pages with Next.js, Webflow, and Framer. This is the first time I know the page will still work in two years without me touching it. Static HTML, zero dependencies."*
|
||||
> — **Daniel Kim**, Growth Engineer
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/startup-landing-page?utm_source=github&utm_medium=readme&utm_content=cta_mid">
|
||||
<img src="https://img.shields.io/badge/⚡️%20Deploy%20Your%20Landing%20Page%20in%2060s-7c3aed?style=for-the-badge" alt="Deploy this template" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
| Feature | Benefit |
|
||||
| :--- | :--- |
|
||||
| **Hero section** | Eye-catching hero with headline, subhead, CTA buttons, and optional background image. |
|
||||
| **Feature grid** | Showcase your product's value props with icons, titles, and descriptions. |
|
||||
| **Pricing table** | Side-by-side plan comparison that drives conversions. |
|
||||
| **Testimonials** | Social proof blocks with quotes, names, and avatars. |
|
||||
| **CTA sections** | Multiple call-to-action blocks placed throughout the page for maximum conversion. |
|
||||
| **Block-based composition** | Reorder, add, or remove sections without rewriting templates. Build like Lego. |
|
||||
| **SEO & AI-ready** | Optimized for search engines and LLMs — your site gets found and recommended. |
|
||||
| **AI page generation** | Describe what you need to [Hugo Chat](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=features_startup-landing-page) — get structured pages with correct front matter instantly. |
|
||||
| **Visual editor** | Drag-and-drop blocks in VS Code with [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable). No coding needed. |
|
||||
| **Plain Markdown** | Every file is human-readable. No database, no lock-in, take your content anywhere. |
|
||||
| **Free hosting** | Deploy to GitHub Pages, Netlify, Vercel, or Cloudflare — all free tier. |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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 Landing Page free**](https://hugoblox.com/templates/startup-landing-page?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 startup-landing-page
|
||||
```
|
||||
|
||||
### Step 2: Customize With AI + Visual Editing
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
**✨ Hugo Chat** — AI customization
|
||||
|
||||
Tell Hugo Chat what you want in plain English. It generates structured pages with the right front matter, shortcodes, and blocks for this template.
|
||||
|
||||
> *"Generate a landing page for my SaaS with hero, pricing, and testimonials"*
|
||||
|
||||
[**Try Hugo Chat — free**](https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=step2_startup-landing-page)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Ownable CMS** — visual editing in VS Code
|
||||
|
||||
1. Install [Ownable CMS](https://marketplace.visualstudio.com/items?itemName=ownable.ownable)
|
||||
2. Open your project in VS Code
|
||||
3. Click the Ownable icon to start editing visually
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
*Ownable CMS: Drag-and-drop page builder inside VS Code.*
|
||||
|
||||
> [!NOTE]
|
||||
> **New to Hugo?** No problem. You don't need to know Hugo — edit visually or write Markdown. 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_startup-landing-page)
|
||||
|
||||
---
|
||||
|
||||
## 🏆 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. Edit visually with Ownable CMS or write Markdown. Hugo is the build engine — you don't need to touch it.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Can I add a contact form?</b></summary>
|
||||
Yes. HugoBlox supports form integrations. Use a third-party service like Formspree or Netlify Forms — no backend required.
|
||||
</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.
|
||||
</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 trained on Hugo and HugoBlox docs. Describe what you want and it generates the right pages with correct front matter. <a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=faq_startup-landing-page">Free to try.</a>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<h2 align="center">🚀 Ready to launch?</h2>
|
||||
|
||||
<p align="center">
|
||||
Deploy in 60 seconds. Customize with AI. Own it as Markdown forever.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hugoblox.com/templates/startup-landing-page?utm_source=github&utm_medium=readme&utm_content=cta_final"><b>Deploy Landing Page — free</b></a>
|
||||
|
|
||||
<a href="https://hugo.chat/?utm_source=github&utm_medium=readme&utm_content=cta_final_startup-landing-page"><b>Customize 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_startup-landing-page)
|
||||
- ⭐ [**Star HugoBlox**](https://github.com/HugoBlox/kit) — help others find it
|
||||
- 🐦 [**Follow on X**](https://x.com/MakeOwnable)
|
||||
|
||||
### Sponsors
|
||||
|
||||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||||
|
||||
---
|
||||
|
||||
MIT © 2016-present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme)
|
||||
Reference in new issue
Block a user