konrad
/
slidev-addon-bibliography
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: clarify installation

This commit is contained in:
kolaente 2022-12-02 17:28:38 +01:00
parent c557c2f950
commit 9dc6780dea
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,8 +4,14 @@ This addons provides a `Sources` and `Source` component to show sources.
## Setup
1. Create a `bibliography.json` file in the root of your slidev presentation with an empty object (`{}`).
2. Create a `setup/main.ts` file with the following contents:
1. Install the addon with your favorite package manager
2. Add it in your frontmatter:
```
addons:
- slidev-addon-bibliography
```
3. Create a `bibliography.json` file in the root of your slidev presentation with an empty object (`{}`).
4. Create a `setup/main.ts` file with the following contents:
```ts
import { defineAppSetup } from '@slidev/types'
import Bibliography from '../bibliography.json'