Skip to content

📽️ Cookiecutter template for beautiful slidev keynotes

Notifications You must be signed in to change notification settings

baggiponte/cookiecutter-slidev

Repository files navigation

logo

A cookiecutter template to generate beautiful sli.dev keynotes to deploy on GitHub Pages

⚡ Features

  • CI/CD automation with GitHub Actions

Warning

⚙️ Deploy to GitHub Pages One manual step is needed for deploying the slideshow with GitHub actions. Go to your repo's Settings > Pages > Build and deployment > Source and select GitHub Actions

🛠️ How to

Install cookiecutter and run the command:

pipx install cookiecutter

cookiecutter gh:baggiponte/cookiecutter-slidev

Warning

🔎 Why pipx? pip install --user is not recommended, as it does not ensure dependency isolation. For this purpose, the Python Packaging Authority (PyPA) advises to use pipx. pipx installs and runs python CLIs in isolated environments. To install it, follow the instructions here.

📝 Fields to fill in

{
  "keynote_reponame": "The GitHub repository slug",
  "keynote_title": "The title of the talk/workshop/keynote",
  "keynote_host": "The conference or host",
  "author_name": "The speakers's name",
  "author_github_handle": "The speaker's GitHub handle",
  "author_job_title": "The speaker's job title",
  "requires_node": "Requires at least node 14."
}

⚠️ Warning

  • The file slides.md sources QR code from ./public/ that point to my personal GitHub and LinkedIn profiles. This is just an example: make sure you remove them!
  • The public/qr-github.svg is missing: you should generate a new one, e.g. using qrcode-monkey.com (not affiliated, just the one I use).

About

📽️ Cookiecutter template for beautiful slidev keynotes

Resources

Stars

Watchers

Forks