Skip to content

Guide

Use this guide when you want to build a Scholarly deck, choose the right template, and tune the theme without reading every reference page first.

Start

New deck:

  • Quick Start: create a deck, pick a template, run it locally.
  • Academic Workflows: choose a paper talk, thesis defense, reading group, course lecture, or results-heavy path.

Existing Slidev deck:

  • Quick Start: add the theme and enable references.
  • Upgrade Notes: check compatibility notes before moving an old deck forward.

Choose Building Blocks

  • Layouts: pick page structures for title, content, methods, results, references, appendix, and Q&A slides.
  • Components: add theorems, blocks, citations, metrics, equations, datasets, paper summaries, and caveats.
  • Syntax Sugar: write common components with Markdown directives instead of Vue tags.

Customize

Work Faster

  • VS Code Extension: snippets, previews, BibTeX helpers, and deck metadata support.
  • Examples: inspect complete examples after you know which pattern you need.