This is a template repository to manage multiple slidev resources.
This repository has an action to build and deploy your slidev presentation on GitHub:
To manage your slidev's resource, clicking Use this template button, and create repository from this template with Include all branches option.
If you missed Include all branches option when creating, you can create orphaned gh-pages branch on your own. (Iclude all branches option is required to deploy your slidev to GitHub Pages on gh-pages branch. If you don't need to deploy your slidev to GitHub Pages, Include all branches option is not needed.)
$ git clone <YOUR_REPOSITORY>
$ cd <YOUR_REPOSITORY_NAME>
$ git checkout --orphan gh-pages
$ git rm -rf .
$ git commit --allow-empty -m "Initial commit"
$ git push origin gh-pages- Write slidev resource in sub directory (e.g.:
example-slidev/,your-own-slidev/) - Creating a tag with the name of sub directory (such as
example-slidev) will start the release action that creates a release and upload slidev presentation as PDF file to the release.- If you enabled GitHub Pages with
gh-pagesbranch, the action will deploy slidev presentation to GitHub Pages as SPA.
- If you enabled GitHub Pages with
This repository has a setup action that will create a pull request to rewrite README.md and remove unnecessary files.
- Check
Settings > Actions > General > Allow GitHub Actions to create and approve pull requestsand clickSave - Make sure "Source:Deploy from a branch"" and "Branch:gh-pages-/(root)" is set in
Settings > Pages > Build and deployment - Run setup action from
Actions > Setup repository > Run workflow > Run workflow - After completing the action, move to
Pull requeststab and merge the pull request created by github-actions
Tip
The pull request create by setup action is here
This repository is licensed under the MIT License. See LICENSE for the full license text.