https://github.com/k2tzumi/about-slidev-boilerplate

https://github.com/k2tzumi/about-slidev-boilerplate

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/k2tzumi/about-slidev-boilerplate
• Owner: k2tzumi
• License: mit
• Created: 2023-12-02T01:06:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-09T01:35:12.000Z (about 1 year ago)
• Last Synced: 2024-10-15T00:23:23.375Z (2 months ago)
• Language: CSS
• Homepage: https://k2tzumi.github.io/about-slidev-boilerplate
• Size: 6.73 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Welcome to [Slidev](https://github.com/slidevjs/slidev)!

To start the slide show:

- `npm install`

- `npm run dev`

- visit http://localhost:3030

Edit the [slides.md](./slides.md) to see the changes.

Learn more about Slidev on [documentations](https://sli.dev/).

## How to publish to GitHub Pages

This repository extends Slidev's Init Project with the following features:

* Installation of several Slidev Addons  

* Lint and build-time validation  

* Version management using [tagpr](https://github.com/Songmu/tagpr)  

* Release management synchronized with version (PDF generation)  

* Publishing to GitHub Pages (OGP, Google tag support)  

Publishing to GitHub Pages is done via Github Actions, but some repository settings are required in advance.   

Please follow the steps below.

1. Enable GitHub Pages [:link:](./settings/pages)    

Select GitHub Actions as the source  

After selection, `github-pages` will be added to Environments.

1. Set `Deployment branches and tags` for `github-pages` in Environments [:link:](./settings/environments)  

Add `tagpr-from-*` to the branch from `Add deployment branch or tag rule`.

1. Change the permissions of GitHub Actions to enable tagpr execution [:link:](./settings/actions)  

Change `Workflow permissions` to `Read and write permissions`, check `Allow GitHub Actions to create and approve pull requests`, and save.

1. Set the Google tag ID in the Repository secrets of GitHub Actions (optional) [:link:](./settings/secrets/actions/new)  

Register a secret named `GA_TRACKING_ID` in `Repository secrets`.  

Publishing to GitHub Pages is linked to the release branch of tagpr when it is merged.