mirror of
https://github.com/tiennm99/HugoBlox-kit.git
synced 2026-10-14 06:17:20 +00:00
214 lines
9.5 KiB
Markdown
214 lines
9.5 KiB
Markdown
# [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&utm_content=preview)
|
|
|
|
<!-- 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 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&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">
|
|
<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?
|
|
|
|
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://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>
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
| 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. |
|
|
|
|
---
|
|
|
|
## 🚀 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 Markdown Slides free**](https://hugoblox.com/templates/markdown-slides?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 markdown-slides
|
|
```
|
|
|
|
### 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 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)
|
|
|
|
---
|
|
|
|
## 🏆 Why HugoBlox?
|
|
|
|
> *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.
|
|
|
|
---
|
|
|
|
## 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 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>
|
|
|
|
---
|
|
|
|
<h2 align="center">🚀 Ready to present?</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/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>
|
|
|
|
---
|
|
|
|
## 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/GoOwnable)
|
|
|
|
### 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)
|