{"id":16582432,"url":"https://github.com/alexanderdavide/slidev-theme-academic","last_synced_at":"2026-01-27T23:47:36.875Z","repository":{"id":40534940,"uuid":"461614605","full_name":"alexanderdavide/slidev-theme-academic","owner":"alexanderdavide","description":"Academic presentations with Slidev made simple 🎓","archived":false,"fork":false,"pushed_at":"2025-04-13T15:13:35.000Z","size":18326,"stargazers_count":142,"open_issues_count":3,"forks_count":34,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-23T16:44:04.481Z","etag":null,"topics":["academic","slidev","slidev-theme","slidev-theme-academic"],"latest_commit_sha":null,"homepage":"https://slidev-theme-academic.alexeble.de","language":"Vue","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/alexanderdavide.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"ko_fi":"alexanderdavide"}},"created_at":"2022-02-20T20:57:13.000Z","updated_at":"2025-09-23T12:54:03.000Z","dependencies_parsed_at":"2024-01-13T19:08:10.401Z","dependency_job_id":"b9bafc16-a9ba-4680-99c9-e310e6943ea2","html_url":"https://github.com/alexanderdavide/slidev-theme-academic","commit_stats":{"total_commits":165,"total_committers":4,"mean_commits":41.25,"dds":"0.048484848484848464","last_synced_commit":"9c9a07a4c4e7a7d28509fb1e7734e8955f262fe7"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/alexanderdavide/slidev-theme-academic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexanderdavide%2Fslidev-theme-academic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexanderdavide%2Fslidev-theme-academic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexanderdavide%2Fslidev-theme-academic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexanderdavide%2Fslidev-theme-academic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexanderdavide","download_url":"https://codeload.github.com/alexanderdavide/slidev-theme-academic/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexanderdavide%2Fslidev-theme-academic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28827902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T23:29:49.665Z","status":"ssl_error","status_checked_at":"2026-01-27T23:25:58.379Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["academic","slidev","slidev-theme","slidev-theme-academic"],"created_at":"2024-10-11T22:32:48.649Z","updated_at":"2026-01-27T23:47:36.866Z","avatar_url":"https://github.com/alexanderdavide.png","language":"Vue","funding_links":["https://ko-fi.com/alexanderdavide"],"categories":[],"sub_categories":[],"readme":"# slidev-theme-academic [![npm](https://img.shields.io/npm/v/slidev-theme-academic?color=blue)](https://www.npmjs.com/package/slidev-theme-academic) ![npm](https://img.shields.io/npm/dw/slidev-theme-academic?color=blue) [![https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://www.conventionalcommits.org/)\n\nSimplifies creating academic presentations with [Slidev](https://github.com/slidevjs/slidev) by providing the necessary components and layouts.\n\n## Install\n\nAdd the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.\n\n```\n---\ntheme: academic\n---\n```\n\nLearn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-theme).\n\n## Layouts\n\n### cover\n\n| **Parameter**              | **Type**      | **Default**                       | **Notes**                                                                         |\n| -------------------------- | ------------- | --------------------------------- | --------------------------------------------------------------------------------- |\n| `coverAuthor`              | Array, String | `undefined`                       | -                                                                                 |\n| `coverAuthorUrl`           | Array, String | `undefined`                       | -                                                                                 |\n| `coverBackgroundUrl`       | String        | `undefined`                       | Adapt the text color with the built-in `class` attribute in the same frontmatter. |\n| `coverBackgroundSource`    | String        | `undefined`                       | -                                                                                 |\n| `coverBackgroundSourceUrl` | String        | `undefined`                       | -                                                                                 |\n| `coverDate`                | String        | `new Date().toLocaleDateString()` | -                                                                                 |\n\n![cover](../assets/example-export/01.png)\n\n### table-of-contents\n\n`table-of-contents` puts custom content above the table of contents. If none is given, the content defaults to `\u003ch1\u003eTable of Contents\u003c/h1\u003e`.\n\n![table-of-contents](../assets/example-export/02.png)\n\n### index\n\n`index` can be used as a general list for figures, references, tables etc..\n\n`index` puts custom content above the list. If none is given, the content defaults to `\u003ch1\u003eIndex\u003c/h1\u003e`.\n\n| **Parameter**               | **Type**                                      | **Default** | **Notes**                                                                              |\n| --------------------------- | --------------------------------------------- | ----------- | -------------------------------------------------------------------------------------- |\n| `indexEntries`\u003csup\u003e\\*\u003c/sup\u003e | `{ title: string, uri?: number \\| string }[]` | `undefined` | Specify `uri` as a page number or optional URL in accordance with `indexRedirectType`. |\n| `indexRedirectType`         | `external \\| internal`                        | `internal`  | -                                                                                      |\n\n![index](../assets/example-export/08.png)\n\n### figure\n\n| **Parameter**            | **Type** | **Default** | **Notes**                |\n| ------------------------ | -------- | ----------- | ------------------------ |\n| `figureCaption`          | String   | `undefined` | -                        |\n| `figureFootnoteNumber`   | Number   | `undefined` | Align with a `Footnote`. |\n| `figureUrl`\u003csup\u003e\\*\u003c/sup\u003e | String   | `undefined` | -                        |\n\n![figure](../assets/example-export/04.png)\n\n### figure-side\n\n| **Parameter**            | **Type** | **Values**   | **Default** | **Notes**                |\n| ------------------------ | -------- | ------------ | ----------- | ------------------------ |\n| `figureCaption`          | String   | -            | `undefined` | -                        |\n| `figureFootnoteNumber`   | Number   | -            | `undefined` | Align with a `Footnote`. |\n| `figureUrl`\u003csup\u003e\\*\u003c/sup\u003e | String   | -            | `undefined` | -                        |\n| `figureX`                | String   | `'l'`, `'r'` | `'r'`       | -                        |\n\n![figure-side](../assets/example-export/05.png)\n\n## Components\n\n### Footnotes\n\n`Footnotes` is to be used as parent of `Footnote` children.\n\n| **Parameter** | **Type** | **Values**       | **Default** | **Notes**                                                       |\n|---------------|----------|------------------|-------------|-----------------------------------------------------------------|\n| `filled`      | Boolean  | `true`, `false`  | `false`     | Overlay subordinate content that may puts itself in background. |\n| `separator`   | Boolean  | `true`, `false`  | `false`     | -                                                               |\n| `x`           | String   | `'l'`, `'r'`     | `'r'`       | -                                                               |\n| `y`           | String   | `'col'`, `'row'` | `'row'`     | -                                                               |\n\n### Footnote\n\n`Footnote` is to be used as children of a `Footnotes` parent.\n\n| **Parameter** | **Type** | **Notes**                                        |\n| ------------- | -------- | ------------------------------------------------ |\n| `number`      | Number   | Align with an attribution in the pages' content. |\n\n![Footnotes \u0026 Footnote](../assets/example-export/06.png)\n\n### Pagination\n\n`Pagination` is rendered globally by default. The global configuration can be defined using [`themeConfig`](#themeconfig).\n\nIf certain pages need individual configuration of `Pagination`, exclude them from global rendering of `Pagination` using [`themeConfig`](#themeconfig) and add `Pagination` manually.\n\n| **Parameter** | **Type**      | **Values**   | **Default** | **Notes**                                                                                    |\n| ------------- | ------------- | ------------ | ----------- | -------------------------------------------------------------------------------------------- |\n| `classNames`  | Array, String | -            | `undefined` | `Pagination` by default uses the color given by the color schema currently active in Slidev. |\n| `x`           | String        | `'l'`, `'r'` | `'r'`       | -                                                                                            |\n| `y`           | String        | `'b'`, `'t'` | `'t'`       | -                                                                                            |\n\n![Pagination](../assets/example-export/07.png)\n\n## themeConfig\n\nGlobal parameters of the theme can be set using the `themeConfig` block in the frontmatter of the first page.\n\nBe aware that defining the `themeConfig` block initializes all parameters as `undefined`; hence you may need to set parameters albeit using defaults.\n\n| **Parameter**             | **Type** | **Values**   | **Default** | **Notes**                                                                                                                                          |\n| ------------------------- | -------- | ------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `paginationPagesDisabled` | Array    | -            | `undefined` | Disable global rendering of `Pagination` for pages having individual `Pagination`.                                                                 |\n| `paginationX`             | String   | `'l'`, `'r'` | `'r'`       | To disable global default rending, set both `paginationX` and `paginationY` to `undefined`. `Pagination` can then still be used on selected pages. |\n| `paginationY`             | String   | `'b'`, `'t'` | `'t'`       | To disable global default rending, set both `paginationX` and `paginationY` to `undefined`. `Pagination` can then still be used on selected pages. |\n\n## Contributing\n\n- `npm run setup`\n- `npm run dev` to start theme preview of `example.md`\n- Edit the `example.md` and style to see the changes\n- `npm run export` to generate the preview PDF\n- `npm run screenshot` to generate the preview PNG\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexanderdavide%2Fslidev-theme-academic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexanderdavide%2Fslidev-theme-academic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexanderdavide%2Fslidev-theme-academic/lists"}