{"id":26513843,"url":"https://github.com/piobeat/gravsupport","last_synced_at":"2025-03-21T04:45:54.913Z","repository":{"id":98144377,"uuid":"100195690","full_name":"PioBeat/GravSupport","owner":"PioBeat","description":"IntelliJ Plugin for Grav","archived":false,"fork":false,"pushed_at":"2020-12-18T17:05:34.000Z","size":4180,"stargazers_count":10,"open_issues_count":3,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-06-07T10:32:11.150Z","etag":null,"topics":["devtools","grav","grav-cms","grav-plugin","intellij","intellij-plugin","php","phpstorm"],"latest_commit_sha":null,"homepage":"","language":"Java","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/PioBeat.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-08-13T18:13:29.000Z","updated_at":"2021-09-26T08:18:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"fddb7f20-48bc-4a89-a5a3-64a4f7385ba2","html_url":"https://github.com/PioBeat/GravSupport","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/PioBeat%2FGravSupport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PioBeat%2FGravSupport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PioBeat%2FGravSupport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PioBeat%2FGravSupport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PioBeat","download_url":"https://codeload.github.com/PioBeat/GravSupport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244739938,"owners_count":20501990,"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":["devtools","grav","grav-cms","grav-plugin","intellij","intellij-plugin","php","phpstorm"],"created_at":"2025-03-21T04:45:54.359Z","updated_at":"2025-03-21T04:45:54.908Z","avatar_url":"https://github.com/PioBeat.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grav Support Plugin\n\n[Grav](https://getgrav.org/) is a flat-file open source CMS.\nThis plugin helps to increase the development speed for Grav-based projects for PhpStorm and IntelliJ IDEA Community / Ultimate.\n\n**Current version:** 0.6.1\n\n**Tested with:**\n\n* PhpStorm 2020.3\n* IntelliJ IDEA Ultimate 2020.3\n\n**Releases:** \nThe plugin is primarily made available via [JetBrain's Plugin Repository](https://plugins.jetbrains.com/plugin/9971-grav-support).\n\n## Install\n\n### JetBrains Plugins Repository\n\nOpen the settings menu \u003ckbd\u003eCTRL+ALT+S\u003c/kbd\u003e or **File | Settings** and then go to **Plugins**. Click on the button _\nBrowse repositories_ and search for\n**Grav Support**. This way you will get notified if a new update is available!\n\n### GitHub Releases\n\n[Download the latest plugin](https://github.com/PioBeat/GravSupport/releases) and install it via the settings\nmenu: \u003ckbd\u003eCTRL+ALT+S\u003c/kbd\u003e or **File | Settings**\nand then under the category **Plugins**, click on the configuration wheel in the top bar and select **Install Plugin\nfrom Disk...**.\n\n### Requirements\n\nThe following requirements must be met in order to use **Grav Support**:\n\n_(basically required if not using PhpStorm or IntelliJ IDEA Ultimate)_\n\n- YAML (already bundled with IntelliJ IDEA)\n- (**Required**) [PHP](https://plugins.jetbrains.com/plugin/6610-php)\n- (**Required**) [Twig Support](https://plugins.jetbrains.com/plugin/7303-twig-support)\n- (**Required**) [PHP Annotations](https://plugins.jetbrains.com/plugin/7320-php-annotations)\n- **(Optional)** [PHP Toolbox](https://plugins.jetbrains.com/plugin/8133-php-toolbox)\n\nThis plugin supports only IntelliJ IDEA Ultimate or PhpStorm.\n\n**Remark: Supported Versions of PHP and Grav**\n\nThis plugin needs a valid PHP installation on the machine. \nPHP should be found in the ``PATH``,\n\nThe latest plugin supports the following Grav versions: 1.6.*, ...\n\nThe plugin uses the scripts in the ``bin`` directory of Grav to offer the functionality Grav supports via those scripts.\n\nFurthermore, I only provide support for **PHP 7.***.\nIf you have a lower version than the plugin may not work correctly.\nTo work with Grav, the PHP extensions `mbstring`, `curl` and `openssl` must be enabled.\n\n## Configuration\n\nIf you create a new Grav project you will have all features enabled by default. \nTherefore, a \"New Project\" wizard for Grav-based projects is provided by the plugin within the IDE.\n\nIf you're opening a previously created project (that was not created with the plugin) you may have to enable the plugin for the current project. \nThe plugin tries to detect a Grav project automatically and notifies the user accordingly. \nOtherwise, open the Settings menu (\u003ckbd\u003eCTRL+ALT+S\u003c/kbd\u003e) and go to **File | Settings | Languages \u0026 Frameworks | Grav** and enable the plugin for the current\nproject.\n\n## Features\n\n(see the changelog for a complete list)\n\n\u003cul\u003e\n    \u003cli\u003eCreate a Grav project by using the wizard\u003c/li\u003e\n    \u003cli\u003eSpecial language file editor\u003c/li\u003e\n    \u003cli\u003eTool window to configure basic config files of Grav\u003c/li\u003e\n    \u003cli\u003eNavigate to the related template file from a page content markdown file\u003c/li\u003e\n    \u003cli\u003eCreate specific configuration files for a theme in the theme directory\n        (\u003ccode\u003eblueprints.yaml\u003c/code\u003e, \u003ccode\u003eTHEME_NAME.yaml\u003c/code\u003e)\u003c/li\u003e\n    \u003cli\u003eRecognition of basic Grav configuration files\u003c/li\u003e\n    \u003cli\u003eCreate new theme (Tools menu or context menu on a Grav project)\u003c/li\u003e\n    \u003cli\u003eTwig intentions\u003c/li\u003e\n\u003c/ul\u003e\n\n## Screenshots\n\n![New Project](.README_images/newproject.png)\n\n![Tool Window](.README_images/toolwindow.png)\n\n![Language Editor](.README_images/languageeditor.png)\n\n\n## Common Issues\n\n**Supported Grav versions**\n\nThe supported Grav versions are fetched from the GitHub repository of [getgrav](https://github.com/getgrav/grav)\nautomatically. They can be selected directly in the project wizard of IntelliJ.\n\nFurthermore, it is possible to use any other Grav installation by manually downloading them and specifying the path in\nthe wizard.\n\n**The Grav plugin does not seem to work on existing projects**\n\nGrav projects that were not created via the project wizard may not be initialized correctly (e.g., module type  is not 'GRAV_TYPE').\n\nA solution is to completely remove the `.idea` folder of the project and re-open it in InteliJ IDEA.\nA notification will be displayed which proposes to convert the project to a \u003ci\u003eGrav project\u003c/i\u003e.\n\n**\"Grav plugin 'devtools' is not installed\"**\n\nIf you get this error message: \"Grav plugin 'devtools' is not installed\"\nafter using the plugin and creating a new theme then you should follow these steps:\n\nMove into your newly created Grav project and type into the console:\n\n```\n$ bin/gpm install devtools\n```\n\nReferences:\n\n* [https://learn.getgrav.org/plugins/plugin-tutorial](https://learn.getgrav.org/plugins/plugin-tutorial)\n* [https://github.com/getgrav/grav-plugin-devtools](https://github.com/getgrav/grav-plugin-devtools)\n\n## Contribution\n\nSupport the plugin if you like it:\n\n- Tell your friends who are using IntelliJ and Grav about this plugin\n- Star it at GitHub\n- Star it on the [JetBrains Plugins Repository](https://plugins.jetbrains.com/plugin/9971-grav-support)\n- Report bugs or feature requests or even fix / implement them\n- Reach out to me directly at dominik@offbeat-pioneer.net\n\n### Implementing Features or Fixing Bugs\n\nFork this repository to your own GitHub account and then clone it to your local device. Open a pull request with\nimprovements.\n\nPlease read\nthe [IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/setting_up_environment.html)\non how to set up the development environment.\n\n#### Build Configuration\n\nThis section provides some hints on how to setup this plugin project.\n\n- Create the file `local.properties` with the following content in the root directory of this project:\n\n```properties\nalternativeIdePathTesting=/path/to/your/phpstorm/installation\n# alternativeIdePathTesting=C:\\\\Program Files\\\\JetBrains\\\\PhpStorm 2020.3\n```\n\n- The `gradle :runIde` task can be started with the following arguments:\n\n```shell\n$ gradlew runIde\n\n# this will use the path specified by 'alternativeIdePathTesting' in 'local.properties' \n$ gradlew runIde -PidePhpStorm \n```\n\n### Reporting Bugs\n\nIf you find any problematic issues, please report them directly by using\nthe [GitHub issue tracker](https://github.com/PioBeat/GravSupport/issues) instead of review comments. This also includes\nfeature requests and enhancements.\n\n**Automatic Bug Reports**\n\nThe plugin offers the possibility to report errors directly within the IDE. If an exception occurs, the user can submit\nthe error by the error reporting feature of IntelliJ. After, the bug report will be added automatically to this\nrepository as an\nissue: [https://github.com/Grav-IntelliJ-Plugin/GravSupport-Plugin-BugTracker/issues](https://github.com/Grav-IntelliJ-Plugin/GravSupport-Plugin-BugTracker/issues)\n.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiobeat%2Fgravsupport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiobeat%2Fgravsupport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiobeat%2Fgravsupport/lists"}