Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
MuTsunTsai committed May 1, 2024
1 parent 763c595 commit 9d3efb0
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,16 @@

[![NPM version](https://img.shields.io/npm/v/slidev-theme-frankfurt?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-frankfurt)

A theme for [Slidev](https://github.com/slidevjs/slidev), inspired by the Frankfurt theme in [Beamer](https://github.com/josephwright/beamer), well-suited for academic talks.

<!--
Learn more about how to write a theme:
https://sli.dev/themes/write-a-theme.html
--->

<!--
run `npm run dev` to check out the slides for more details of how to start writing a theme
-->
A theme for [Slidev](https://github.com/slidevjs/slidev),
inspired by the Frankfurt theme in [Beamer](https://github.com/josephwright/beamer),
well-suited for academic talks.

![](screenshots/01.png)

## Install

Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
Add the following frontmatter to your `slides.md`.
Start Slidev and then it will prompt you to install the theme automatically.

```yaml
---
Expand All @@ -33,7 +27,9 @@ Learn more about [how to use a theme](https://sli.dev/themes/use).

## Using sections

The main feature of Frankfurt theme is the section and progress indicators on top. To divide your slides into sections, add the following frontmatter to the first page of each section:
The main feature of Frankfurt theme is the section and progress indicators on top.
To divide your slides into sections,
add the following frontmatter to the first page of each section:

```yaml
---
Expand Down

0 comments on commit 9d3efb0

Please sign in to comment.