tiennm99/HugoBlox-kit
1
0 Fork 0
mirror of https://github.com/tiennm99/HugoBlox-kit.git synced 2026-10-12 14:14:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add cli to readme

Browse Source
This commit is contained in:
George Cushen committed 2025-11-20 22:30:06 +00:00
1 parent 89ab4d1a34
commit eaa9bc1e29
4 files changed
+81 -61
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.cursorindexingignore
+3
View File
@@ -0,0 +1,3 @@
# Don't index SpecStory auto-save files, but allow explicit context inclusion via @ references
.specstory/**
.gitignore
+1
View File
@@ -39,6 +39,7 @@ starters/**/pnpm-lock.yaml
# IDE & Editor files
.idea/
.vscode/
.specstory/
# ============================================================================
# Language & Framework Specific
README.md
+39 -32
View File
@@ -6,19 +6,17 @@
</a>
</p>
<h1 align="center">The #1 Open Source Toolkit for Technical & Academic Websites</h1>
<h1 align="center">The Open Source Copilot for Technical & Academic Websites</h1>
<p align="center">
<strong>Accelerate Your Impact:</strong> Build blazing-fast, SEO-optimized sites in minutes.<br/>
<!-- Trusted by 250,000+ innovators at <strong>Meta, Stanford, Google, MIT, and OpenAI</strong>. -->
<strong>Build a "Future-Proof" Brand in the AI Era.</strong><br/>
The choice of rockstar researchers and founders at <strong>Meta, Stanford, NVIDIA, and Y Combinator</strong>.
</p>
<p align="center">
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme"><b>🚀 Get Started Free</b></a>
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme"><b>🚀 Launch Copilot (Free)</b></a>
&nbsp;•&nbsp;
<a href="https://hugoblox.com/pro?utm_source=github&utm_medium=readme">Go Pro</a>
<!-- &nbsp;•&nbsp;
<a href="https://discord.gg/z8wNYzb">Join Discord</a> -->
</p>
<p align="center">
@@ -35,12 +33,18 @@
---
## Why Hugo Blox?
## Why Top Talent Chooses Hugo Blox
- **Launch in Minutes, Not Months:** Pick a template, customize with drag-and-drop blocks, and deploy. Build anything from SaaS landing pages and online courses to academic resumés and lab sites.
- **Own Your Content & Brand:** You get static files with no vendor lock-in, leading to 100/100 Lighthouse scores. Your content, your rules.
- **Built for a Technical Workflow:** A modern stack with Hugo and Tailwind CSS. Write in Markdown, Jupyter, or BibTeX. Auto-sync publications.
- **Open & Extendable:** Start with a generous MIT-licensed core. Upgrade with premium templates and blocks or extend with React "islands" for custom interactivity.
In the age of AI agents, **Markdown is the new source code**.
Vibe coding tools generate fragile, "black box" React/JS apps that are a nightmare to maintain once the AI disconnects. **Hugo Blox** is different. We combine the speed of an AI builder with the robustness of a static site generator.
- **🔮 Future-Proof & AI Ready:** Your content lives in clean Markdown—the native language of LLMs. It's readable by humans and machines forever. No vendor lock-in.
- **🧠 The "Copilot" Workflow:**
- **Online:** Use our AI-assisted deployer to launch in 60 seconds.
- **VS Code (Coming Soon):** Write content and visualize blocks directly in your editor with our upcoming AI extension.
- **⚡ Performance without Debt:** Get perfect 100/100 Lighthouse scores. Zero "JS bloat". We handle the heavy lifting (Tailwind 4, Hugo Modules) so you focus on your research/startup.
- **🎓 Research-Grade Features:** Native support for LaTeX math, BibTeX auto-citations, and Jupyter Notebooks. If you publish papers, this is your unfair advantage.
<p align="center">
<img src="./.github/media/templates.webp" alt="Template previews" width="900">
@@ -52,48 +56,51 @@
---
## Get started
## Get Started
**Recommended (fastest, no install):**
👉 [**Start free in your browser**](https://hugoblox.com/start?utm_source=github&utm_medium=readme) — pick a template, customize blocks, and publish to GitHub Pages.
### Option 1: The Online Copilot (Fastest)
**Prefer the CLI?**
Use the local quickstart:
Launch a professional site for your Lab, Startup, or Bio in under 2 minutes.
👉 [**Start Free in Browser**](https://hugoblox.com/start?utm_source=github&utm_medium=readme)
### Option 2: The CLI (For Developers)
Prefer the terminal? Use our local copilot to scaffold your site:
```bash
# 1) Install Hugo Extended → https://docs.hugoblox.com/getting-started/install-hugo/#prerequisites
# 2) Clone a starter (example: Academic CV) - see https://hugoblox.com/templates
git clone https://github.com/HugoBlox/theme-academic-cv my-site
cd my-site
# 3) Run locally
pnpm install && hugo server -D
npx hugoblox create
```
*Prerequisites: [Hugo Extended & Node](https://docs.hugoblox.com/getting-started/install-hugo/#prerequisites).
For more guides, visit our documentation at [**https://docs.hugoblox.com/**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme).
---
## Free vs. Pro
Hugo Blox ships with a library of **free blocks** for heroes, features, testimonials, FAQs, and more. **Pro** is a one-time donation that adds **exclusive, professionally designed blocks** and full site templates to help you launch even faster.
**Hugo Blox** is open core. You can build a world-class site for free. **Pro** is for those who want to move faster and support the ecosystem.
<!-- <p align="center">
<img src="./.github/media/blocks-strip.png" alt="Premium blocks preview" width="900">
</p> -->
| Feature | Open Source | **Hugo Blox Pro** |
| :--- | :---: | :---: |
| **Core Framework** | ✅ | ✅ |
| **Standard Blocks** (Hero, Features, etc.) | ✅ | ✅ |
| **Premium Templates** (SaaS, Course, Lab) | ❌ | **✅ Included** |
| **Exclusive Pro Blocks** | ❌ | **✅ Included** |
| **Lifetime Updates** | ❌ | **✅ Included** |
| **Support the Project** | ❤️ | **🏆 Hero Status** |
- Free templates & blocks: [**Templates Catalog**](https://hugoblox.com/templates?utm_source=github&utm_medium=readme)
- Pro catalog & lifetime updates: [**Go Pro**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
👉 [**Upgrade to Pro**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
---
## What Creators Say
> “Hugo Blox saved me 40+ hours on my lab site. Bibtex integration auto-updates publications — **our citations are up 3×**.”
> "Hugo Blox saved me 40+ hours on my lab site. Bibtex integration auto-updates publications — **our citations are up 3×**."
> — **Dr. Sarah Yang**, AI Researcher
> “We launched our documentation in 10 minutes. The block system is genius; **onboarding time dropped by 60%**.”
> "We launched our documentation in 10 minutes. The block system is genius; **onboarding time dropped by 60%**."
> — **Alexandre Rodrigues**, Founder
---
README.zh.md
+38 -29
View File
@@ -6,19 +6,17 @@
</a>
</p>
<h1 align="center">技术/学术网站的开源王牌工具箱</h1>
<h1 align="center">技术 / 学术网站的开源 Copilot</h1>
<p align="center">
<strong>效率拉满：</strong> 几分钟上线，性能和 SEO 都很能打。<br/>
<!-- 受到 250,000+ 创新者青睐（Meta、Stanford、Google、MIT、OpenAI 等）。 -->
<strong>在 AI 时代，为你的个人品牌和团队打造一份「面向未来」的数字资产。</strong><br/>
被来自 <strong>Meta、Stanford、NVIDIA 以及一线创业公司 / 实验室</strong> 的研究者和创始人青睐。
</p>
<p align="center">
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme"><b>🚀 免费开始</b></a>
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme"><b>🚀 启动 Copilot（免费）</b></a>
&nbsp;•&nbsp;
<a href="https://hugoblox.com/pro?utm_source=github&utm_medium=readme"><b>立即升级 Pro（终身）</b></a>
<!-- &nbsp;•&nbsp;
<a href="https://discord.gg/z8wNYzb">加入 Discord</a> -->
<a href="https://hugoblox.com/pro?utm_source=github&utm_medium=readme"><b>升级 Pro（终身）</b></a>
</p>
<p align="center">
@@ -35,12 +33,18 @@
---
## 为什么选 Hugo Blox？
## 为什么顶尖开发者和研究者选择 Hugo Blox？
- **分钟级上线，不再内耗：** 选模板 → 拖拽积木 → 发布。SaaS 落地页、在线课程、学术简历、实验室主页… 都能一把梭。
- **完全掌控内容与品牌：** 纯静态输出，无厂商锁定，轻松冲 100/100 Lighthouse 分数。内容归你，你做主。
- **技术范儿十足：** Hugo + Tailwind CSS 现代栈。支持 Markdown、Jupyter、BibTeX，出版物自动同步，工作流丝滑顺手。
- **开源且可扩展：** MIT 核心慷慨开源。可用 React “小岛”增强交互，或升级 Pro 解锁更多专业模板与积木。
在智能体 / Copilot 时代，**Markdown 正在变成新的「源码」**。
市面上各种 vibe coding / 生成式建站工具，会一股脑吐出一大坨难以维护的 React/JS 黑盒代码，一旦离开那个 AI，很快就失控。**Hugo Blox 选的是另一条路：用极简的静态站栈，配上开源 Copilot 体验。**
- **🔮 面向未来的内容资产：** 内容以干净的 Markdown 存储——这是 LLM 和人类都读得懂的格式，迁移简单、长期可用，没有厂商锁定。
- **🧠 Copilot 工作流：**
- **在线 Copilot：** 在浏览器里选模板、拼积木，60 秒内上线到 GitHub Pages。
- **VS Code 扩展（即将发布）：** 在编辑器中写内容、可视化区块布局，用 AI 辅助生成和重构网页文案。
- **⚡ 性能拉满、无技术债：** 静态输出 + 极少 JS，轻松冲击 100/100 Lighthouse 分数，不会拖慢你实验/产品的主战场。
- **🎓 为学术 & 深度技术场景而生：** 原生支持 LaTeX 数学公式、BibTeX 引用自动导入、Jupyter 集成——从论文到项目页，全链路一站搞定。
<p align="center">
<img src="./.github/media/templates.webp" alt="模板预览" width="900">
@@ -54,33 +58,38 @@
## 快速上手
**推荐（最快、零安装）：**
👉 [**浏览器里直接开干**](https://hugoblox.com/start?utm_source=github&utm_medium=readme) — 选模板、改积木、发布到 GitHub Pages。
### 方案一：在线 Copilot（最快、零安装）
**命令行选手？**
使用本地快速开始：
👉 [**浏览器里直接开干**](https://hugoblox.com/start?utm_source=github&utm_medium=readme) — 选模板、拖拽积木、接入 GitHub，一键发布到 GitHub Pages。
### 方案二：命令行 Copilot（本地开发者）
偏爱命令行？用本地 Copilot 快速生成站点骨架：
```bash
# 1) 安装 Hugo Extended → https://docs.hugoblox.com/getting-started/install-hugo/#prerequisites
# 2) 克隆一个起步模板（示例：Academic CV）- 更多模板见 https://hugoblox.com/templates
git clone https://github.com/HugoBlox/theme-academic-cv my-site
cd my-site
# 3) 本地运行
pnpm install && hugo server -D
npx hugoblox create
```
更多指南请访问文档 [**https://docs.hugoblox.com/**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme)。
*前置条件：[Hugo Extended & Node](https://docs.hugoblox.com/getting-started/install-hugo/#prerequisites)。*
更多上手指南，请访问文档 [**https://docs.hugoblox.com/**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme)。
---
## Free vs. Pro
## 开源版 vs Pro 版
Hugo Blox 自带一套用于 Hero、Features、Testimonials、FAQs 等的**免费积木**。**Pro** 为一次性捐赠，解锁**独家、专业设计的高级积木**与整站模板，助你更快更稳地上线。
Hugo Blox 是 **开源内核 + Pro 增强** 的模式。你可以用开源版搭建一流站点；如果你希望更快推进项目、同时支持生态发展，可以考虑升级 Pro。
- 免费模板与积木：[**模板目录**](https://hugoblox.com/templates?utm_source=github&utm_medium=readme)
- Pro 目录与终身更新：[**立即升级 Pro（终身）**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
| 能力 | 开源版 | **Hugo Blox Pro** |
| :--- | :---: | :---: |
| **核心框架** | ✅ | ✅ |
| **标准积木**（Hero、功能介绍等） | ✅ | ✅ |
| **高级整站模板**（SaaS、课程、实验室主页等） | ❌ | **✅ 全部解锁** |
| **独家 Pro 积木** | ❌ | **✅ 全部解锁** |
| **终身更新** | ❌ | **✅ 包含** |
| **支持项目 / 赞助开源** | ❤️ | **🏆 真爱用户** |
👉 [**升级 Pro（终身）**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
---