Documentation Map

New to Scholarly? Follow Quick start. Use this page when you need to find a specific guide or reference.

Start and maintain a project

• Quick start: installation, authoring, PDF export, and static builds.
• VS Code extension: projects, Deck Builder, completions, and diagnostics.
• Upgrade notes: dependency updates and older configurations.
• Examples: complete decks and layout galleries.
• Feature overview: capabilities and offline use.

Choose a talk structure

The Academic Workflows guide covers paper talks, thesis defenses, literature reviews, results talks, and course lectures.

Layout reference

Layouts arrange a whole slide:

• Structure: cover, outline, section breaks, adaptive content, and closing.
• Content: columns, figures, images, and lists.
• Emphasis: quotes, statistics, statements, and questions.
• Academic: paper summaries, methods, evidence, Q&A, and references.

Component reference

Components add content inside a slide:

• Statements: Theorem, Block, Highlight.
• Page composition: Columns, Steps, Keywords.
• Results: MetricCard, MetricGrid, ResultTable.
• Evidence: EvidenceBlock, EquationBlock, DatasetCard.
• Research context: PaperCard, ContributionList, CaveatList.
• Sources: Citations, footnotes, and anchors.
• Palette samples: ThemePreview.

For shorter component syntax, see Markdown directives. For imported values, see Data-Driven Slides.

Configure the deck

• Configuration: field locations, authors, footer, numbering, and font sizes.
• Colors and typography: palettes, font pairings, and custom colors.
• Theme Mode and Contrast: light/dark controls, precedence, and readability.

Contribute

Contributing covers the repository setup, checks, bilingual documentation, and preview updates.