{"id":13598102,"url":"https://github.com/OleVik/grav-theme-scholar","last_synced_at":"2025-04-10T06:31:04.881Z","repository":{"id":37875681,"uuid":"152952685","full_name":"OleVik/grav-theme-scholar","owner":"OleVik","description":"Scholar is an academic-focused theme, for publishing papers, articles, books, documentation, your blog, and even your resumé, with Grav.","archived":false,"fork":false,"pushed_at":"2024-09-27T06:36:43.000Z","size":54643,"stargazers_count":15,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-06T22:41:12.978Z","etag":null,"topics":["academic","docs","documentation","grav","publishing","theme"],"latest_commit_sha":null,"homepage":"https://olevik.net/staging/grav-skeleton-scholar","language":"PHP","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/OleVik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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},"funding":{"custom":["olevik.me/services","paypal.me/olevik"],"ko_fi":"olevik"}},"created_at":"2018-10-14T08:09:50.000Z","updated_at":"2024-07-31T20:29:51.000Z","dependencies_parsed_at":"2024-01-14T04:43:06.579Z","dependency_job_id":"23b72eaa-1c38-4bfe-a126-5c2c21058d62","html_url":"https://github.com/OleVik/grav-theme-scholar","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OleVik%2Fgrav-theme-scholar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OleVik%2Fgrav-theme-scholar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OleVik%2Fgrav-theme-scholar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OleVik%2Fgrav-theme-scholar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OleVik","download_url":"https://codeload.github.com/OleVik/grav-theme-scholar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248168186,"owners_count":21058782,"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":["academic","docs","documentation","grav","publishing","theme"],"created_at":"2024-08-01T17:00:48.107Z","updated_at":"2025-04-10T06:30:59.859Z","avatar_url":"https://github.com/OleVik.png","language":"PHP","funding_links":["olevik.me/services","paypal.me/olevik","https://ko-fi.com/olevik"],"categories":["PHP"],"sub_categories":[],"readme":"# Scholar Theme\n\nScholar is an academic-focused theme, for publishing papers, articles, books, documentation, your blog, and even your resumé, with [Grav](https://getgrav.org/).\n\n## Features\n\n- Extensible Components, Layouts and template-partials, Styles, API\n- Responsive Layouts, multiple Styles\n  - Print-friendly\n- Performant, light on resources\n- Accessible, tested against WCAG AA, Section 508, and best practices\n  - Navigable by keyboard and screen readers\n  - Readable contrast across Styles\n  - Clean, declarative HTML-structure with semantic labels\n- Automated Evergreen-browser compatibility\n- Compatible with a static setup\n- Dynamic functionality for Data, Embed, Print, and Search Pages\n\nA demonstration is available at [OleVik.me/staging/grav-skeleton-scholar](https://olevik.me/staging/grav-skeleton-scholar), and its full contents are on [GitHub](https://github.com/OleVik/grav-skeleton-scholar).\n\n## Usage\n\n### Configuration\n\n| Option              | Default   | Description                                   |\n|---------------------|-----------|-----------------------------------------------|\n| enabled             | true      | Enable theme                                  |\n| style               | metal     | Default Style to load                         |\n| toolbar.breadcrumbs | true      | Enable breadcrumbs in toolbar                 |\n| toolbar.search      | true      | Enable search-field in toolbar                |\n| toolbar.navigation  | true      | Enable navigation-drawer in toolbar           |\n| css                 | true      | Load theme's CSS                              |\n| js                  | true      | Load theme's JS                               |\n| itemize             | true      | Assign indices to paragraphs                  |\n| linked_data         | true      | Generated Linked Data                         |\n| highlighter         | true      | Highlight code                                |\n| highlighter_theme   | enlighter | Theme for highlighter                         |\n| components          | [List]    | List of components to enable                  |\n| router              | true      | Enable dynamic routes                         |\n| routes              | [Dict]    | Key-value list of routes                      |\n| api                 | [Dict]    | Hierarchical key-value list of classes to use |\n| flexsearch          | [Dict]    | Options for FlexSearch                        |\n| flexsearch.enabled  | true      | Enable FlexSearch                             |\n\n## Installation\n\n### Version 3.0.0 and higher\n\nThis major-version update targets compatibility with Grav Core 1.7, and also updates and changes some internals.\n\n### Grav Package Manager\n\nThe simplest way to install this theme is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal -- also called the command line. From the root of your Grav install type:\n\n    bin/gpm install scholar\n\nThis will install the Scholar-theme into your `/user/themes` directory within Grav. Its files can be found under `/your/site/grav/user/themes/scholar`.\n\n## Manual Installation\n\nTo install this theme, just download the zip version of this repository and unzip it under `/your/site/grav/user/themes`. Then, rename the folder to `scholar`.\n\nYou should now have all the theme files under\n\n    /your/site/grav/user/themes/scholar\n\nThis theme started as a clone of Paul Hibbitt's [Learn2 with Git Sync](https://github.com/hibbitts-design/grav-theme-learn2-git-sync)-theme, which is a customized version of the [Learn2](https://github.com/getgrav/grav-theme-learn2)-theme, and drew inspiration from [HTML5Up's Future Imperfect template](https://html5up.net/future-imperfect). As this theme decouples and supercedes most of the logic in either, it is rebranded as Scholar. It also goes much further in what a documentation-theme can be and do.\n\n## [Advanced Usage](https://github.com/OleVik/grav-theme-scholar/blob/master/ADVANCED.md)\n\n## [Development](https://github.com/OleVik/grav-theme-scholar/blob/master/DEVELOPMENT.md)\n\n## [Contributing](https://github.com/OleVik/grav-theme-scholar/blob/master/CONTRIBUTING.md)\n\n## TODO\n\n- [ ] Evaluate metadata text-wrapping\n- [ ] Search: Replace with engine-agnostic approach, decoupling into a plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOleVik%2Fgrav-theme-scholar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOleVik%2Fgrav-theme-scholar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOleVik%2Fgrav-theme-scholar/lists"}