Slidev Theme Scholarly

中文版 · Live Demo · Documentation

A professional presentation theme for Slidev, designed specifically for academic presentations with LaTeX Beamer-inspired styling.

⚠️ Major Upgrade in Progress

Upcoming versions may include breaking changes. Please check the Upgrade Notes before updating.

Try the pre-release:

npm i -D slidev-theme-scholarly@next

✨ Key Features

| Feature | Description | |---------|-------------| | 🎓 Professional Design | LaTeX Beamer-inspired with academic styling | | 📐 26 Layouts | Structure, Content, Emphasis, and Academic categories | | 🧩 Rich Components | Theorem, Block, Citations, Steps, Keywords, Columns, Highlight | | 🎨 9 Color Themes | Classic Blue, Oxford, Cambridge, Yale, Princeton, Nordic, Monochrome, Sepia, High Contrast | | 📚 Citations & Footnotes | BibTeX bibliography plus academic Markdown footnotes with inline preview | | 📝 Syntax Sugar | Simplified Markdown directives for components | | 🔧 VS Code Extension | Snippets, previews, and BibTeX integration |

🚀 Quick Start

Installation

npm i -D slidev-theme-scholarly

Create with CLI (Recommended)

# one-time usage
npx -y --package slidev-theme-scholarly sch init my-talk

# after package is installed in a workspace
npx sch init my-talk --template academic
# or
npx sts init my-talk --template academic

Available templates:

npx sch template list

Generated starters work out of the box with Scholarly's built-in citation support. Normal theme usage does not require a project-level vite.config.

Common commands:

# show help
npx sch help
npx sch help theme

# list Scholarly presets and assets
npx sch theme list
npx sch layout list
npx sch component list
npx sch snippet list

# apply Scholarly visual preset to slides frontmatter
npx sch theme apply oxford-burgundy --font traditional --file slides.md
npx sch theme preset apply oxford --file slides.md

# append academic snippet blocks into slides
npx sch snippet append theorem --file slides.md
npx sch snippet append references --file slides.md

# append full scholarly workflow skeleton
npx sch workflow list
npx sch workflow apply paper --file slides.md

# check environment and project readiness (includes Scholarly checks)
npx sch doctor

Create Manually

---
theme: scholarly
authors:
  - name: Your Name
    institution: Your University
footerMiddle: Conference 2026
---

# Your Presentation Title

Subtitle or description

---

# Introduction

- Point 1
- Point 2
- Point 3

BibTeX citations and the references layout work automatically once the theme is enabled. Use layout: references for a generated bibliography slide, or add [[bibliography]] only when you need custom placement inside that slide.

Preview

npx slidev

📐 Layouts

Layouts are organized into four categories:

Structure Layouts

| Layout | Description | |--------|-------------| | cover | Title slide with authors | | default | Standard content slide | | intro | Section introduction | | section | Chapter divider | | center | Centered content | | auto-center | Auto-centered content | | auto-size | Default flow with fit-to-page sizing | | end | Closing slide |

Content Layouts

| Layout | Description | |--------|-------------| | two-cols | Two-column layout | | image-left | Image on left, text on right | | image-right | Image on right, text on left | | bullets | Enhanced bullet list | | figure | Academic figure with caption | | split-image | Split image layout |

Emphasis Layouts

| Layout | Description | |--------|-------------| | quote | Styled quotation | | fact | Single fact/statistic | | statement | Important statement | | focus | Focused statement with icon |

Academic Layouts

| Layout | Description | |--------|-------------| | compare | Side-by-side comparison | | methodology | Research methodology | | results | Research results | | timeline | Timeline visualization | | agenda | Presentation agenda | | acknowledgments | Acknowledgments | | references | Bibliography |

View Layout Documentation →

🧩 Components

| Component | Description | Example | |-----------|-------------|---------| | Theorem | Theorems, lemmas, definitions | <Theorem type="theorem">...</Theorem> | | Block | Beamer-style info blocks | <Block type="info">...</Block> | | Citations | BibTeX citations | @citekey or !@citekey | | Steps | Process visualization | <Steps :steps="[...]" /> | | Keywords | Keyword tags | <Keywords :keywords="[...]" /> | | Columns | Multi-column layout | <Columns :columns="2">...</Columns> | | Highlight | Text highlighting | <Highlight>text</Highlight> |

View Component Documentation →

🎨 Theme Gallery

At the top of each slide, add:

• Yale Blue
• Princeton Orange
• Nordic Blue
• Monochrome
• Warm Sepia
• High Contrast

View All Themes →

Use for: Most of your slides (this is automatic!)

🔧 VS Code Extension

Boost your productivity with our VS Code extension:

• 🎯 Secondary Side Bar panel for layouts/components
• ✨ Snippets: type ss- to insert layouts/components
• ⚡ Smart completion for layout:, themeConfig, <components>, and ::: directives
• 📚 BibTeX integration with auto-complete
• 👁️ Visual Previews: Directly preview layouts, components, and themes in the sidebar

Download from Releases →

🤝 Contributing

We welcome contributions!

# Install dependencies
pnpm install

# Start development server
pnpm run dev

# Build
pnpm run build

View Contributing Guide →

📄 License

MIT License - see LICENSE for details.

🔗 Links

• 📖 Documentation
• 🎬 Live Demo
• 🐛 Issues
• 💬 Discussions
• 📦 NPM Package