{"id":20522230,"url":"https://github.com/paritoshbh/grav-coder","last_synced_at":"2025-03-06T00:29:09.094Z","repository":{"id":47406201,"uuid":"146148962","full_name":"ParitoshBh/grav-coder","owner":"ParitoshBh","description":null,"archived":false,"fork":false,"pushed_at":"2022-08-12T21:29:53.000Z","size":353,"stargazers_count":28,"open_issues_count":2,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-16T10:40:24.414Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://paritoshbh.me","language":"Twig","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/ParitoshBh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-26T03:41:35.000Z","updated_at":"2024-09-03T13:16:26.000Z","dependencies_parsed_at":"2022-09-22T20:40:45.009Z","dependency_job_id":null,"html_url":"https://github.com/ParitoshBh/grav-coder","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParitoshBh%2Fgrav-coder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParitoshBh%2Fgrav-coder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParitoshBh%2Fgrav-coder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParitoshBh%2Fgrav-coder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ParitoshBh","download_url":"https://codeload.github.com/ParitoshBh/grav-coder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242127759,"owners_count":20076170,"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":[],"created_at":"2024-11-15T22:34:36.976Z","updated_at":"2025-03-06T00:29:09.063Z","avatar_url":"https://github.com/ParitoshBh.png","language":"Twig","readme":"# Grav Coder\n\nGrav Coder is a fork of [Hugo Coder](https://github.com/luizdepra/hugo-coder) and derived from customizations made to it by [Khosrow Moossavi](https://github.com/khos2ow) for his own personal website.\n\n![Grav Coder](assets/screenshot.png)\n\n# Installation\n\nInstalling the Grav Coder theme can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the theme with a simple terminal command, while the manual method enables you to do so via a zip file.\n\n### GPM Installation (Preferred)\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 grav-coder\n\nThis will install the Grav Coder theme into your `/user/themes` directory within Grav. Its files can be found under `/yoursite/user/themes/grav-coder`.\n\n### Manual Installation\n\nTo install this theme, just download the zip version of this repository and unzip it under `/yoursite/user/themes`. Then, rename the folder to `grav-coder`. You can find these files either on [GitHub](https://github.com/ParitoshBh/grav-coder) or via [GetGrav.org](http://getgrav.org/downloads/themes).\n\nYou should now have all the theme files under\n\n    /yoursite/user/themes/grav-coder\n\n# Updating\n\nAs development for the Grav Coder theme continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Grav Coder is easy, and can be done through Grav's GPM system, as well as manually.\n\n### GPM Update (Preferred)\n\nThe simplest way to update this theme is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:\n\n    bin/gpm update grav-coder\n\nThis command will check your Grav install to see if your Grav Coder theme is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The theme will automatically update and clear Grav's cache.\n\n### Manual Update\n\nManually updating Grav Coder is pretty simple. Here is what you will need to do to get this done:\n\n* Delete the `yoursite/user/themes/grav-coder` directory.\n* Download the new version of the Grav Coder theme from either [GitHub](https://github.com/ParitoshBh/grav-coder) or [GetGrav.org](http://getgrav.org/downloads/themes#extras).\n* Unzip the zip file in `yoursite/user/themes` and rename the resulting folder to `grav-coder`.\n* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.\n\n\u003e Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/themes`) will remain intact.\n\n# Features\n\n* Lightweight and minimal for optimal performance\n* Fontawesome icon support\n* Default view template\n* Blog view template\n* Blog item view template\n* Categories view (listing)\n* Pagination support (defaults to 10 items per page)\n* Taxonomy display support\n\n# Setup\n\nIf you want to set Grav Coder as the default theme, you can do so by following these steps:\n\n* Navigate to `/yoursite/user/config`.\n* Open the **system.yaml** file.\n* Change the `theme:` setting to `grav-coder`.\n* Save your changes.\n* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in Terminal and typing `bin/grav clear-cache`.\n\n### Homepage Setup\n\n* Navigate to `/yoursite/user/pages`.\n* Create `home` directory (remove/rename/backup existing `home` directory, if any)\n* Under `home` directory, create `default.md` and put in html content you'd like to see on homepage. Example,\n   ```html\n    \u003cdiv class=\"about\"\u003e\n      \u003ch1\u003eGrav Coder\u003c/h1\u003e\n      \u003ch2\u003eAn Open Source Theme For Grav CMS\u003c/h2\u003e\n    \u003c/div\u003e\n   ```\n\n### Blog (Listing) Setup\n\n* Navigate to `/yoursite/user/pages`.\n* Create `01.blog` directory\n* Under `01.blog` directory, create `blog.md` with following content,\n   ```md\n    ---\n    content:\n        items: '@self.children'\n        order:\n            by: date\n            dir: desc\n        limit: 10\n        pagination: true\n    metadata:\n      description: 'Some description for metadata'\n    ---\n   ```\n* Each blog post would then be a directory under `01.blog` directory. Example, `01.blog/sample-article` directory will have `item.md` in it with contents of the post.\n\n### Navigation Bar Menu Items\n\nFor creating additional menu items (apart from `Home`) in nav bar simply create a directory under `user/pages/` eg. `03.Portfolio` (don't forget to increment the numeric value). As of now you can create 2 different types of pages,\n1. Containing HTML content - Under `02.portfolio` directory create `default.md` (with html content in it)\n1. Listing page (similar to a `blog` page) - Structure is similar to `blog`\n\nOnce this is done, you should be able to see the new theme on the frontend.\n\n# Customizations\n\nThere are certain sections of the theme you can customize, in order to do so,\n* Create `themes` directory under `/yoursite/user/config` (skip this step if it already exists)\n* Overwrite or extend styles inside `custom.css` under `/yoursite/user/themes/yourtheme/css`\n* Create `grav-coder.yaml` file under `/yoursite/user/config/themes` (this makes sure any configurations made to theme persist when updating the theme)\n* Within `grav-coder.yaml` file following configuration are available,\n  ```\n  navbar:\n    # Title in navigation bar\n    title: Grav Coder\n    # Login link in navbar\n    # Note: Logout link appears automatically if enabled in following format,\n    # \u003cFULL_NAME\u003e, Logout or \u003cUSERNAME\u003e, Logout (if full name isn't available)\n    auth_link:\n      enabled: false\n      login_slug: login\n      login_label: Login\n\n  # Copyright text visible in footer and (start) year\n  # If 'copyright_start_year' is not defined then it isn't shown\n  footer:\n    copyright: Grav Coder\n    copyright_start_year: 2018\n\n  # Social media icons, displayed in footer, above copyright text\n  social:\n    github:\n      title: Github\n      url: \u003curl\u003e\n      icon: fab fa-github\n      rel: me (disabled by default, add to activate)\n    twitter:\n      title: Twitter\n      url: \u003curl\u003e\n      icon: fab fa-twitter\n      rel: me (disabled by default, add to activate)\n    linkedin:\n      title: LinkedIn\n      url: \u003curl\u003e\n      icon: fab fa-linkedin-in\n      rel: me (disabled by default, add to activate)\n    stackoverflow:\n      title: StackOverflow\n      url: \u003curl\u003e\n      icon: fab fa-stack-overflow\n      rel: me (disabled by default, add to activate)\n\n  # Navigation links (prev/next) on post page (enabled by default)\n  # Taxonomy links on post page (enabled by default)\n  post:\n    navigation: false\n    taxonomy: false\n\n  # Pagination - number of items to show per page\n  pagination:\n    count: 10\n  ``` \n\nA couple of pointers for social media icons, \n* There isn't any limit on how many icons you can add (so be careful not to over crowd the footer)\n* Font awesome (ver. 5.2.0) is supported and hence you can use pretty much any icon listed on its [website](https://fontawesome.com/icons?d=gallery) under `icon`\n* To add social media icons (apart from those listed above), simply add the following block after `stackoverflow` block\n   ```\n    facebook:\n      title: Facebook\n      url: \u003curl\u003e\n      icon: fab fa-facebook-f\n   ```\n\n# Third Party Libraries Used\n\nIn its current iteration, Grav Coder relies on below listed 3rd party libraries,\n* Bootstrap (ver. 3.3.7)\n* jQuery (slim) (ver. 3.3.1)\n* Fontawesome Icons (ver. 5.2.0)\n* Google Fonts\n* [Normalize.css](https://github.com/necolas/normalize.css) (ver. 8.0.0)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparitoshbh%2Fgrav-coder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparitoshbh%2Fgrav-coder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparitoshbh%2Fgrav-coder/lists"}