mirror of
https://github.com/tiennm99/HugoBlox-kit.git
synced 2026-10-05 14:14:41 +00:00
228 lines
9.4 KiB
Markdown
228 lines
9.4 KiB
Markdown
[**中文**](./README.zh.md)
|
||
|
||
<p align="center">
|
||
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=hero_image">
|
||
<img src="./.github/media/hero.png" alt="Build world-class sites with HugoBlox" width="100%">
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">HugoBlox: Your Open Publishing Stack</h1>
|
||
|
||
<p align="center">
|
||
<strong>Publish notebooks, docs, portfolios, and knowledge bases from Markdown + Jupyter.</strong><br/>
|
||
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).
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=cta_start"><b>Start Free in Browser</b></a>
|
||
•
|
||
<a href="https://marketplace.visualstudio.com/items?itemName=lore.lore-studio"><b>Get Lore Studio (VS Code)</b></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<sub>
|
||
<a href="#for-researchers--labs">Researchers & Labs</a>
|
||
•
|
||
<a href="#for-data-scientists--ai-engineers">Data Scientists & AI Engineers</a>
|
||
•
|
||
<a href="#for-teams--orgs">Teams & Orgs</a>
|
||
•
|
||
<a href="#-pricing--features-open-core">Pricing</a>
|
||
</sub>
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
[](https://discord.gg/z8wNYzb)
|
||
[](https://github.com/HugoBlox/kit)
|
||
[](https://x.com/LoreLabs_)
|
||
[](./LICENSE.md)
|
||
|
||
</div>
|
||
|
||
<p align="center">
|
||
<sub>
|
||
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>
|
||
</sub>
|
||
</p>
|
||
|
||
---
|
||
|
||
## ⚡️ Why teams choose HugoBlox
|
||
|
||
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).
|
||
|
||
- **Own your content**: clean Markdown, YAML, and notebooks — portable, readable, and LLM-friendly.
|
||
- **Performance without the ops tax**: static output, fast builds, no runtime database.
|
||
- **Beautiful by default**: high-quality templates + blocks (and Pro options when you want more).
|
||
- **A hybrid workflow**: edit in code, or use a visual editor when you want velocity.
|
||
|
||
---
|
||
|
||
## For researchers & labs
|
||
|
||
- **Lab sites and academic profiles** (people, publications, projects, news)
|
||
- **Citable output** with BibTeX/DOI workflows
|
||
- **Notebooks + LaTeX** for technical writing that actually renders
|
||
|
||
## For data scientists & AI engineers
|
||
|
||
- **Project docs** and technical blogs without heavy JavaScript stacks
|
||
- **Notebook-first publishing** (`.ipynb`) for reports, tutorials, and results
|
||
- **Knowledge bases** and internal docs that stay searchable and maintainable
|
||
|
||
## For teams & orgs
|
||
|
||
- **Consistent sites** across teams with templates + blocks
|
||
- **Lower risk upgrades** with clear versioning + migration guidance
|
||
- **Support options** when you need fast answers
|
||
|
||
---
|
||
|
||
## 🧠 Edit the way you like (code-first, visual when you want it)
|
||
|
||
- **Code-first**: Markdown/YAML + Hugo templates for full control.
|
||
- **Visual editing (Pro)**: **Lore Studio** in VS Code for drag-and-drop blocks, previews, and safer config edits.
|
||
- **AI automation (Pro)**: spend less time on formatting, YAML fixes, imports, and maintenance.
|
||
|
||
<p align="center">
|
||
<img src="./.github/media/studio/slide-1.webp" alt="Lore Studio in Action" width="100%">
|
||
</p>
|
||
<p align="center"><em>Lore Studio: Visual editing meets code-first control.</em></p>
|
||
|
||
---
|
||
|
||
## 🛠️ The toolkit
|
||
|
||
| **Feature** | **Why it matters** |
|
||
| :--- | :--- |
|
||
| **Lore Studio (VS Code)** | A visual CMS inside your editor. Drag-and-drop blocks without leaving VS Code. |
|
||
| **Notebooks & LaTeX** | Render `.ipynb` and math-heavy pages natively. |
|
||
| **BibTeX / DOI workflows** | Build publication pages and bibliographies without manual formatting. |
|
||
| **Polyglot Support** | Write in Markdown, Jupyter, RMarkdown, or LaTeX Math. |
|
||
|
||
<p align="center">
|
||
<img src="./.github/media/templates.webp" alt="Template previews" width="900">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://hugoblox.com/templates?utm_source=github&utm_medium=readme&utm_content=templates"><b>Browse Templates →</b></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<sub>Want to see it working fast? Pick a template and publish in ~60 seconds with the Online Copilot.</sub><br/>
|
||
<a href="https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=cta_template_start"><b>Try a template now →</b></a>
|
||
</p>
|
||
|
||
---
|
||
|
||
## 🚀 Get Started
|
||
|
||
### Option 1: The Online Copilot (Fastest)
|
||
Ideal for **founders, labs, and startups**. Launch a site in minutes.
|
||
|
||
👉 [**Start Free in Browser**](https://hugoblox.com/start?utm_source=github&utm_medium=readme&utm_content=get_started_browser)
|
||
|
||
### Option 2: Lore Studio (Best for Data/AI teams)
|
||
The power of a visual website builder, directly inside VS Code.
|
||
|
||
1. **Install** [Lore Studio from the Marketplace](https://marketplace.visualstudio.com/items?itemName=lore.lore-studio).
|
||
2. **Open** any HugoBlox project folder.
|
||
3. **Click** the Lore Studio icon in the menu to start visually editing.
|
||
|
||
### Option 3: The CLI (For DevOps/Eng)
|
||
Scaffold a new project locally.
|
||
|
||
```bash
|
||
# Requires Hugo Extended & Node.js
|
||
npm install -g hugoblox
|
||
hugoblox create site
|
||
```
|
||
|
||
Need guides and best practices? See the docs: [**docs.hugoblox.com**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme&utm_content=docs)
|
||
|
||
---
|
||
|
||
## ✅ Stability & upgrades (because your site should not break)
|
||
|
||
- **Pin versions** to keep production stable.
|
||
- **Upgrade with confidence** using migration notes and upgrade guides.
|
||
- **Customize safely**: prefer configuration and blocks over fragile template overrides when possible.
|
||
- **Catch config issues early (Pro)**: visual editing + validation reduces YAML/front matter mistakes.
|
||
|
||
See the docs for upgrade guidance: [**docs.hugoblox.com**](https://docs.hugoblox.com/?utm_source=github&utm_medium=readme&utm_content=upgrade_guidance)
|
||
|
||
---
|
||
|
||
## 💎 Pricing & Features (Open Core)
|
||
|
||
HugoBlox is **Open Core**. The **Free Kit** is production-grade and you will always own your data and code.
|
||
|
||
The Free Kit includes:
|
||
|
||
- **Templates + blocks** for portfolios, labs, docs, and landing pages
|
||
- **Markdown/YAML-first workflow** with Hugo + Tailwind performance
|
||
- **Notebook + LaTeX support** for technical publishing
|
||
- **Community support** via docs, GitHub issues, and Discord
|
||
|
||
Upgrade to **Pro** when you want automation and lower maintenance overhead:
|
||
|
||
- **Less time debugging YAML** (Fix-it Bot + safer config editing)
|
||
- **Less time formatting citations** (Magic Import + publication automation)
|
||
- **Less time dealing with upgrades** (guided maintenance workflows)
|
||
- **More velocity** (visual editing + previews in VS Code)
|
||
|
||
|
||
| Feature | **Free Kit** (Open Source) | **Pro** (Automation) |
|
||
| :--- | :---: | :---: |
|
||
| **Code Ownership** | ✅ 100% Yours | ✅ 100% Yours |
|
||
| **Visual Editor in Lore Studio** | ❌ | **✅ Included** |
|
||
| **AI "Fix-It" Bot** (Auto-fix YAML) | ❌ | **✅ Unlimited** |
|
||
| **Magic Import** (BibTeX/DOI -> Page) | ⏳ Trial | **✅ Unlimited** |
|
||
| **CV Generator** (Site -> PDF Resume) | ❌ | **✅ Included** |
|
||
| **Private Discord Support** | ❌ | **✅ Priority** |
|
||
|
||
👉 [**View Full Feature Matrix**](https://hugoblox.com/pricing?utm_source=github&utm_medium=readme&utm_content=pricing_matrix) • [**Go Pro**](https://hugoblox.com/pro?utm_source=github&utm_medium=readme&utm_content=cta_pro)
|
||
|
||
---
|
||
|
||
> "Lore Studio saved me **40+ hours** on my lab site. Visual edits + BibTeX auto-updates = **citations up 3×**."
|
||
> <br/>— **Dr. Sarah Yang**, AI Researcher
|
||
|
||
> "Launched docs in **10 minutes**. The block system is genius; onboarding time dropped 60%."
|
||
> <br/>— **Alexandre Rodrigues**, Founder
|
||
|
||
---
|
||
|
||
## 🏢 Org-ready (without the enterprise bloat)
|
||
|
||
- **Deploy anywhere**: static output works with your existing infra.
|
||
- **Lower ops surface area**: no runtime app to patch.
|
||
- **Procurement-friendly options**: priority support and commercial features when you need them.
|
||
|
||
---
|
||
|
||
## 🗣️ Community & Support
|
||
|
||
We are a community of 150,000+ researchers, engineers, and creators.
|
||
|
||
- **Need Help?** Join the [Discord Server](https://discord.gg/z8wNYzb) or search the [Documentation](https://docs.hugoblox.com/).
|
||
- **Found a Bug?** Open an [Issue](https://github.com/HugoBlox/kit/issues).
|
||
- **Want to Contribute?** Read our [Contributing Guide](./CONTRIBUTING.md).
|
||
|
||
### Sponsors
|
||
Help us keep open-source sustainable.
|
||
|
||
[**❤️ Sponsor on GitHub**](https://github.com/sponsors/gcushen) | [**🏢 Become a Partner**](https://github.com/sponsors/gcushen)
|
||
|
||
---
|
||
|
||
## License
|
||
|
||
Copyright © 2016-Present [**Lore Labs**](https://lore.tech/?utm_source=github&utm_medium=readme).
|
||
Released under the [MIT License](./LICENSE.md).
|
||
|
||
<p align="center">
|
||
<sub>Lore™ is a trademark of Lore Labs.</sub>
|
||
</p>
|