Go to file
kolaente c557c2f950
chore: add license
2022-12-02 17:23:15 +01:00
components feat: add components 2022-12-02 17:22:19 +01:00
.envrc chore: add gitignore 2022-12-02 16:47:19 +01:00
.gitignore chore: add gitignore 2022-12-02 16:47:19 +01:00
LICENSE chore: add license 2022-12-02 17:23:15 +01:00
README.md feat: add components 2022-12-02 17:22:19 +01:00
flake.lock feat: add flake 2022-12-02 16:45:30 +01:00
flake.nix feat: add flake 2022-12-02 16:45:30 +01:00
package.json feat: init package 2022-12-02 16:49:51 +01:00
pnpm-lock.yaml feat: init package 2022-12-02 16:49:51 +01:00

README.md

Slidev bibliography addons

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:
import { defineAppSetup } from '@slidev/types'
import Bibliography from '../bibliography.json'

export default defineAppSetup(({ app }) => {
    app.provide('bibliography', Bibliography)
})

Usage

In the bibliography.json file, add sources like this:

{
  "ot": {
    "url": "https://en.wikipedia.org/wiki/Operational_transformation"
  },
  "crdtPaper": {
    "title": "Nuno Preguiça: Conflict-free Replicated Data Types: An Overview. arXiv:1806.10254, June 2018."
  }
}

Each source can have a url, a title or both.

In your slides, reference a source like this:

* Something <Source item="ot"/>

It will then show up in the slide with a reference like [0].

On the slide where you want to include all used sources, simply add the <Sources/> component. It will show all sources you've used in order of appearance.

License

MIT