{"id":22980218,"url":"https://github.com/kaakaa/slidev-resources-template","last_synced_at":"2025-08-13T17:33:08.293Z","repository":{"id":167474612,"uuid":"642409142","full_name":"kaakaa/slidev-resources-template","owner":"kaakaa","description":"Template repository to manage and build slidev resources","archived":false,"fork":false,"pushed_at":"2024-05-19T14:08:38.000Z","size":3028,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-20T03:31:58.154Z","etag":null,"topics":["slidev"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kaakaa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-18T13:55:41.000Z","updated_at":"2024-05-19T14:08:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"e2441e08-9ae2-4b6d-bbe4-032b2862af05","html_url":"https://github.com/kaakaa/slidev-resources-template","commit_stats":null,"previous_names":["kaakaa/slidev-resources-template"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaakaa%2Fslidev-resources-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaakaa%2Fslidev-resources-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaakaa%2Fslidev-resources-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaakaa%2Fslidev-resources-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaakaa","download_url":"https://codeload.github.com/kaakaa/slidev-resources-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229773606,"owners_count":18122031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["slidev"],"created_at":"2024-12-15T01:38:07.646Z","updated_at":"2024-12-15T01:38:08.240Z","avatar_url":"https://github.com/kaakaa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Release slidev](https://github.com/kaakaa/slidev-resources-template/actions/workflows/release.yaml/badge.svg)](https://github.com/kaakaa/slidev-resources-template/actions/workflows/release.yaml)\n# Slidev Resources Template\n\nThis is a template repository to manage multiple [slidev](https://sli.dev) resources.\n\nThis repository has an action to build and deploy your slidev presentation on GitHub:\n* [GitHub Releases(PDF)](https://github.com/kaakaa/slidev-resources-template/releases/tag/example-slidev)\n* [GitHub Pages(SPA)](https://kaakaa.github.io/slidev-resources-template/)\n\n![sturcture](./assets/structure.png)\n\n# Getting Started\n\nTo manage your slidev's resource, clicking `Use this template` button, and create repository from this template with `Include all branches` option. \n\n![create-repo.png](./assets/create-repo.png)\n\nIf 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.)\n\n```sh\n$ git clone \u003cYOUR_REPOSITORY\u003e\n$ cd \u003cYOUR_REPOSITORY_NAME\u003e\n$ git checkout --orphan gh-pages\n$ git rm -rf .\n$ git commit --allow-empty -m \"Initial commit\"\n$ git push origin gh-pages\n```\n\n## How to write and build your slidev\n\n1. Write slidev resource in sub directory (e.g.: `example-slidev/`, `your-own-slidev/`)\n2. 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.\n   * If you enabled GitHub Pages with `gh-pages` branch, the action will deploy slidev presentation to GitHub Pages as SPA.\n\n## Setup repository (Optional)\n\nThis repository has a setup action that will create a pull request to rewrite `README.md` and remove unnecessary files. \n\n1. Check `Settings \u003e Actions \u003e General \u003e Allow GitHub Actions to create and approve pull requests` and click `Save`\n2. Make sure \"Source:**Deploy from a branch**\"\" and \"Branch:**gh-pages-/(root)**\" is set in `Settings \u003e Pages \u003e Build and deployment`\n3. Run setup action from `Actions \u003e Setup repository \u003e Run workflow \u003e Run workflow`\n4. After completing the action, move to `Pull requests` tab and merge the pull request created by github-actions\n\n![run-setup-workflow](./assets/run-setup-workflow.png)\n\n\u003e [!TIP]\n\u003e The pull request create by setup action is [here](https://github.com/kaakaa/slidev-resources-template/pull/15)\n\n# License\n\nThis repository is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaakaa%2Fslidev-resources-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaakaa%2Fslidev-resources-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaakaa%2Fslidev-resources-template/lists"}