Skip to content

Commit 1352d89

Browse files
gcushengcushen
committed
docs: edit
1 parent 96aa043 commit 1352d89

File tree

34 files changed

+159
-4300
lines changed

34 files changed

+159
-4300
lines changed

‎CITATION.cff‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ type: software
44

55
title: "HugoBlox"
66
abstract: >
7-
HugoBlox is an open-research copilot for publishing scientific and technical content with Hugo.
8-
It provides a no-code block system, Markdown-first content, and research-focused
9-
features such as LaTeX math, BibTeX citations, and Jupyter Notebook support.
7+
HugoBlox is an open-source ecosystem for building high-performance research portfolios,
8+
lab websites, and technical documentation. Designed for data sovereignty, it enables
9+
data scientists and researchers to publish reproducible content directly from Markdown,
10+
Jupyter Notebooks, and BibTeX, eliminating the need for complex JavaScript dependencies
11+
or proprietary AI platforms.
1012
1113
authors:
1214
- family-names: "Cushen"
@@ -19,8 +21,8 @@ url: "https://hugoblox.com"
1921
doi: 10.5281/zenodo.17704062
2022

2123
# Use the latest released version here
22-
version: "0.10.0"
23-
date-released: 2025-11-08
24+
version: "0.11.0"
25+
date-released: 2026-01-02
2426

2527
keywords:
2628
- hugo

‎LICENSE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016-present George Cushen (https://georgecushen.com/)
3+
Copyright © 2016-Present [**Lore Labs**](https://lore.tech).
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

‎README.md‎

Lines changed: 148 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,227 @@
11
[**中文**](./README.zh.md)
22

33
<p align="center">
4-
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme">
4+
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=hero_image">
55
<img src="./.github/media/hero.png" alt="Build world-class sites with HugoBlox" width="100%">
66
</a>
77
</p>
88

9-
<h1 align="center">HugoBlox: Your Open Research Copilot</h1>
9+
<h1 align="center">HugoBlox: Your Open Publishing Stack</h1>
1010

1111
<p align="center">
12-
<strong>Build a "Future-Proof" Brand in the AI Era.</strong><br/>
13-
The choice of rockstar researchers and founders at <strong>Meta, Stanford, NVIDIA, and Y Combinator</strong>.
12+
<strong>Publish notebooks, docs, portfolios, and knowledge bases from Markdown + Jupyter.</strong><br/>
13+
Built for data scientists, AI engineers, researchers, labs, and tech startups who want speed without lock-in: Hugo + Tailwind with optional Pro automation (visual editing, imports, fixes, and upgrades).
1414
</p>
1515

1616
<p align="center">
17-
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme"><b>🚀 Launch Copilot (Free)</b></a>
17+
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=cta_start"><b>Start Free in Browser</b></a>
1818
&nbsp;•&nbsp;
19-
<a href="https://hugoblox.com/pro?utm_source=github&utm_medium=readme">Go Pro</a>
19+
<a href="https://marketplace.visualstudio.com/items?itemName=lore.lore-studio"><b>Get Lore Studio (VS Code)</b></a>
2020
</p>
2121

2222
<p align="center">
23-
<a href="https://discord.gg/z8wNYzb">
24-
<img src="https://img.shields.io/discord/722225264733716590?label=Join%20Discord&style=social" alt="Discord">
25-
</a>
26-
<a href="https://github.com/HugoBlox/kit">
27-
<img src="https://img.shields.io/github/stars/HugoBlox/kit?label=Star%20Hugo%20Blox&style=social" alt="GitHub Stars">
28-
</a>
29-
<a href="https://x.com/LoreLabs_">
30-
<img src="https://img.shields.io/twitter/follow/LoreLabs_?label=Follow&style=social" alt="Follow on X">
31-
</a>
23+
<sub>
24+
<a href="#for-researchers--labs">Researchers & Labs</a>
25+
&nbsp;•&nbsp;
26+
<a href="#for-data-scientists--ai-engineers">Data Scientists & AI Engineers</a>
27+
&nbsp;•&nbsp;
28+
<a href="#for-teams--orgs">Teams & Orgs</a>
29+
&nbsp;•&nbsp;
30+
<a href="#-pricing--features-open-core">Pricing</a>
31+
</sub>
32+
</p>
33+
34+
<div align="center">
35+
36+
[![Discord](https://img.shields.io/discord/722225264733716590?label=Join%20Discord&logo=discord&style=flat-square&color=5865F2)](https://discord.gg/z8wNYzb)
37+
[![GitHub stars](https://img.shields.io/github/stars/HugoBlox/kit?style=flat-square&logo=github)](https://github.com/HugoBlox/kit)
38+
[![Follow on X](https://img.shields.io/badge/Follow-LoreLabs_-1DA1F2?style=flat-square&logo=x)](https://x.com/LoreLabs_)
39+
[![License](https://img.shields.io/github/license/HugoBlox/kit?style=flat-square)](./LICENSE.md)
40+
41+
</div>
42+
43+
<p align="center">
44+
<sub>
45+
Trusted since <strong>2016</strong> · <strong>150,000+</strong> researchers and scientists (Meta, Stanford, NVIDIA) · Rated <strong>4.9/5</strong> by users (official survey) · Used by teams like <a href="https://research.nvidia.com/research-labs">NVIDIA Research Labs</a>, <a href="https://cai4cai.ml/">King’s College London</a>, and <a href="https://www.metaconscious.org/">MIT</a> · Featured by GitHub <a href="https://github.blog/open-source/release-radar-february-2019/#hugo-academic-4-0">Release Radar</a>
46+
</sub>
3247
</p>
3348

3449
---
3550

36-
## Why Top Talent Chooses HugoBlox
51+
## ⚡️ Why teams choose HugoBlox
3752

38-
In the age of AI agents, **Markdown is the new source code**. HugoBlox empowers STEM researchers, data scientists, innovative labs, and YC startups to create stunning, high-impact websites without the hassle.
53+
In the age of AI, **Markdown is the new source code**. HugoBlox gives you the speed of modern tooling with the durability of a static stack: **Hugo + Tailwind** (with optional Alpine/Svelte blocks for interactivity).
3954

40-
Vibe coding tools generate fragile, "black box" React/JS apps that are a nightmare to maintain. **HugoBlox** combines AI speed with static site robustness, now supercharged with **Lore Studio** – your visual UI editor in VS Code.
55+
- **Own your content**: clean Markdown, YAML, and notebooks — portable, readable, and LLM-friendly.
56+
- **Performance without the ops tax**: static output, fast builds, no runtime database.
57+
- **Beautiful by default**: high-quality templates + blocks (and Pro options when you want more).
58+
- **A hybrid workflow**: edit in code, or use a visual editor when you want velocity.
4159

42-
- **🔮 Future-Proof & AI Ready:** Content in clean Markdown – readable by humans and LLMs. No lock-in.
43-
- **🧠 The "Copilot" Workflow:**
44-
- **Online:** AI-assisted deployer launches in 60 seconds.
45-
- **VS Code:** Introducing **Lore Studio** – visual editing, real-time previews, and smart configs right in your IDE.
46-
- **⚡ Performance without Debt:** Perfect Lighthouse scores, zero JS bloat, powered by Tailwind 4 and Hugo Modules.
47-
- **🎓 Research-Grade Features:** LaTeX, BibTeX auto-citations, Jupyter integration – amplify your publications.
60+
---
61+
62+
## For researchers & labs
63+
64+
- **Lab sites and academic profiles** (people, publications, projects, news)
65+
- **Citable output** with BibTeX/DOI workflows
66+
- **Notebooks + LaTeX** for technical writing that actually renders
4867

49-
![Lore Studio in Action](.github/media/studio/slide-1.webp)
50-
*Build stunning research portfolios in minutes – focus on breakthroughs, not code.*
68+
## For data scientists & AI engineers
5169

52-
![Visual Configuration Editor](.github/media/studio/slide-2.webp)
53-
*Instant previews and smart suggestions – elevate your site effortlessly.*
70+
- **Project docs** and technical blogs without heavy JavaScript stacks
71+
- **Notebook-first publishing** (`.ipynb`) for reports, tutorials, and results
72+
- **Knowledge bases** and internal docs that stay searchable and maintainable
5473

55-
![Theme Selector](.github/media/studio/slide-3.webp)
56-
*A visual CMS in VS Code – discovery time, not deployment drudgery.*
74+
## For teams & orgs
75+
76+
- **Consistent sites** across teams with templates + blocks
77+
- **Lower risk upgrades** with clear versioning + migration guidance
78+
- **Support options** when you need fast answers
79+
80+
---
81+
82+
## 🧠 Edit the way you like (code-first, visual when you want it)
83+
84+
- **Code-first**: Markdown/YAML + Hugo templates for full control.
85+
- **Visual editing (Pro)**: **Lore Studio** in VS Code for drag-and-drop blocks, previews, and safer config edits.
86+
- **AI automation (Pro)**: spend less time on formatting, YAML fixes, imports, and maintenance.
5787

5888
<p align="center">
59-
<a href="https://marketplace.visualstudio.com/items?itemName=lore.lore-studio"><b>📥 Download Lore Studio Now (Free)</b></a>
89+
<img src="./.github/media/studio/slide-1.webp" alt="Lore Studio in Action" width="100%">
6090
</p>
91+
<p align="center"><em>Lore Studio: Visual editing meets code-first control.</em></p>
92+
93+
---
94+
95+
## 🛠️ The toolkit
96+
97+
| **Feature** | **Why it matters** |
98+
| :--- | :--- |
99+
| **Lore Studio (VS Code)** | A visual CMS inside your editor. Drag-and-drop blocks without leaving VS Code. |
100+
| **Notebooks & LaTeX** | Render `.ipynb` and math-heavy pages natively. |
101+
| **BibTeX / DOI workflows** | Build publication pages and bibliographies without manual formatting. |
102+
| **Polyglot Support** | Write in Markdown, Jupyter, RMarkdown, or LaTeX Math. |
61103

62104
<p align="center">
63105
<img src="./.github/media/templates.webp" alt="Template previews" width="900">
64106
</p>
65107

66108
<p align="center">
67-
<a href="https://hugoblox.com/templates?utm_source=github&utm_medium=readme"><b>Browse Templates →</b></a>
109+
<a href="https://hugoblox.com/templates?utm_source=github&utm_medium=readme&utm_content=templates"><b>Browse Templates →</b></a>
110+
</p>
111+
112+
<p align="center">
113+
<sub>Want to see it working fast? Pick a template and publish in ~60 seconds with the Online Copilot.</sub><br/>
114+
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=cta_template_start"><b>Try a template now →</b></a>
68115
</p>
69116

70117
---
71118

72-
## Get Started
119+
## 🚀 Get Started
73120

74121
### Option 1: The Online Copilot (Fastest)
75-
Launch a professional site for your Lab, Startup, or Bio in under 2 minutes.
122+
Ideal for **founders, labs, and startups**. Launch a site in minutes.
76123

77-
👉 [**Start Free in Browser**](https://hugoblox.com/start?utm_source=github&utm_medium=readme)
124+
👉 [**Start Free in Browser**](https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=get_started_browser)
78125

79-
### Option 2: Lore Studio in VS Code (Visual Powerhouse)
80-
Supercharge your workflow with our VS Code extension – visual editing for pros.
126+
### Option 2: Lore Studio (Best for Data/AI teams)
127+
The power of a visual website builder, directly inside VS Code.
81128

82-
1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=lore.lore-studio).
83-
2. Open your HugoBlox project in VS Code.
84-
3. Click the HugoBlox icon and start building visually!
129+
1. **Install** [Lore Studio from the Marketplace](https://marketplace.visualstudio.com/items?itemName=lore.lore-studio).
130+
2. **Open** any HugoBlox project folder.
131+
3. **Click** the Lore Studio icon in the menu to start visually editing.
85132

86-
### Option 3: The CLI (For Developers)
87-
Prefer the terminal? Scaffold with our local copilot:
133+
### Option 3: The CLI (For DevOps/Eng)
134+
Scaffold a new project locally.
88135

89136
```bash
90-
npx hugoblox create
137+
# Requires Hugo Extended & Node.js
138+
npm install -g hugoblox
139+
hugoblox create site
91140
```
92141

93-
*Prerequisites: [Hugo Extended & Node](https://docs.hugoblox.com/start/cli/).
142+
Need guides and best practices? See the docs: [**docs.hugoblox.com**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme&utm_content=docs)
143+
144+
---
145+
146+
## ✅ Stability & upgrades (because your site should not break)
94147

95-
For more guides, visit [**docs.hugoblox.com**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme).
148+
- **Pin versions** to keep production stable.
149+
- **Upgrade with confidence** using migration notes and upgrade guides.
150+
- **Customize safely**: prefer configuration and blocks over fragile template overrides when possible.
151+
- **Catch config issues early (Pro)**: visual editing + validation reduces YAML/front matter mistakes.
152+
153+
See the docs for upgrade guidance: [**docs.hugoblox.com**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme&utm_content=upgrade_guidance)
96154

97155
---
98156

99-
## Free vs. Pro
157+
## 💎 Pricing & Features (Open Core)
100158

101-
**HugoBlox** is open core. Build world-class sites for free. **Pro** accelerates with Studio and premium features.
159+
HugoBlox is **Open Core**. The **Free Kit** is production-grade and you will always own your data and code.
102160

103-
| Feature | Open Source | **HugoBlox Pro** |
104-
| :--- | :---: | :---: |
105-
| **Core Framework** | ✅ | ✅ |
106-
| **Studio Site Editor** | ❌ | **✅ Included** |
107-
| **Premium Templates** (SaaS, Lab) | ❌ | **✅ Included** |
108-
| **Exclusive Pro Blocks** | ❌ | **✅ Included** |
109-
| **Remove Attribution?** | ❌ | **✅ Included** |
110-
| **Discord Support** | ❤️ | **⚡️ Priority** |
111-
| **Support Open Research** | ❤️ | **🏆 Hero Status** |
161+
The Free Kit includes:
112162

113-
👉 [**Upgrade to Pro**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
163+
- **Templates + blocks** for portfolios, labs, docs, and landing pages
164+
- **Markdown/YAML-first workflow** with Hugo + Tailwind performance
165+
- **Notebook + LaTeX support** for technical publishing
166+
- **Community support** via docs, GitHub issues, and Discord
114167

115-
---
168+
Upgrade to **Pro** when you want automation and lower maintenance overhead:
116169

117-
## What Creators Say
170+
- **Less time debugging YAML** (Fix-it Bot + safer config editing)
171+
- **Less time formatting citations** (Magic Import + publication automation)
172+
- **Less time dealing with upgrades** (guided maintenance workflows)
173+
- **More velocity** (visual editing + previews in VS Code)
118174

119-
> "Lore Studio saved me 40+ hours on my lab site. Visual edits + Bibtex auto-updates = citations up 3×."
120-
> — **Dr. Sarah Yang**, AI Researcher
121175

122-
> "Launched docs in 10 minutes with Studio. Block system is genius; onboarding dropped 60%."
123-
> — **Alexandre Rodrigues**, Founder
176+
| Feature | **Free Kit** (Open Source) | **Pro** (Automation) |
177+
| :--- | :---: | :---: |
178+
| **Code Ownership** | ✅ 100% Yours | ✅ 100% Yours |
179+
| **Visual Editor in Lore Studio** | ❌ | **✅ Included** |
180+
| **AI "Fix-It" Bot** (Auto-fix YAML) | ❌ | **✅ Unlimited** |
181+
| **Magic Import** (BibTeX/DOI -> Page) | ⏳ Trial | **✅ Unlimited** |
182+
| **CV Generator** (Site -> PDF Resume) | ❌ | **✅ Included** |
183+
| **Private Discord Support** | ❌ | **✅ Priority** |
184+
185+
👉 [**View Full Feature Matrix**](https://hugoblox.com/pricing?utm_source=github&utm_medium=readme&utm_content=pricing_matrix) &nbsp;•&nbsp; [**Go Pro**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme&utm_content=cta_pro)
124186

125187
---
126188

127-
## Support the Project
189+
> "Lore Studio saved me **40+ hours** on my lab site. Visual edits + BibTeX auto-updates = **citations up 3×**."
190+
> <br/>— **Dr. Sarah Yang**, AI Researcher
128191
129-
- 💎 **Pro (only $8/m)** — Unlock Studio, premium templates, and all updates.
130-
<br/>[**Go Pro →**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme)
192+
> "Launched docs in **10 minutes**. The block system is genius; onboarding time dropped 60%."
193+
> <br/>— **Alexandre Rodrigues**, Founder
131194
132-
- ☕️ **Donate a Coffee** — Fuel open source and research.
133-
<br/>[**Sponsor on GitHub →**](https://github.com/sponsors/gcushen)
195+
---
196+
197+
## 🏢 Org-ready (without the enterprise bloat)
134198

135-
- 🤝 **Corporate Sponsors** — Reach thousands. Get your logo here.
136-
<br/>[**Become a Partner →**](https://github.com/sponsors/gcushen)
199+
- **Deploy anywhere**: static output works with your existing infra.
200+
- **Lower ops surface area**: no runtime app to patch.
201+
- **Procurement-friendly options**: priority support and commercial features when you need them.
137202

138203
---
139204

140-
## Community
205+
## 🗣️ Community & Support
206+
207+
We are a community of 150,000+ researchers, engineers, and creators.
208+
209+
- **Need Help?** Join the [Discord Server](https://discord.gg/z8wNYzb) or search the [Documentation](https://docs.hugoblox.com/).
210+
- **Found a Bug?** Open an [Issue](https://github.com/HugoBlox/kit/issues).
211+
- **Want to Contribute?** Read our [Contributing Guide](./CONTRIBUTING.md).
141212

142-
Join to ask questions, share work, and improve.
213+
### Sponsors
214+
Help us keep open-source sustainable.
143215

144-
- 💬 [Discord](https://discord.gg/z8wNYzb)
145-
- 📚 [Docs & Guides](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme)
146-
- 🐦 [X / Twitter](https://x.com/LoreLabs_)
147-
- ⭐ [Star on GitHub](https://github.com/HugoBlox/kit)
216+
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
148217

149218
---
150219

151220
## License
152221

153-
MIT © 2016–Present [George Cushen](https://georgecushen.com/?utm_source=github&utm_medium=hbb-readme) — [License Details](./LICENSE.md)
222+
Copyright © 2016-Present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme).
223+
Released under the [MIT License](./LICENSE.md).
154224

155225
<p align="center">
156-
<sub>No tracking. No lock-in. Your content stays yours.</sub>
226+
<sub>Lore™ is a trademark of Lore Labs.</sub>
157227
</p>

‎README.zh.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,9 @@ npx hugoblox create
150150

151151
## 许可证
152152

153-
MIT © 2016–Present [George Cushen](https://georgecushen.com/?utm_source=github&utm_medium=hbb-readme) — [License 详情](./LICENSE.md)
153+
Copyright © 2016-Present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme).
154+
Released under the [MIT License](./LICENSE.md).
154155

155156
<p align="center">
156-
<sub>无追踪。无锁定。您的内容始终属于您。</sub>
157+
<sub>Lore™ is a trademark of Lore Labs.</sub>
157158
</p>

0 commit comments

Comments
 (0)