{"id":15380769,"url":"https://github.com/bitstarr/grav-plugin-company-details","last_synced_at":"2026-02-04T10:06:39.611Z","repository":{"id":188265521,"uuid":"678408634","full_name":"bitstarr/grav-plugin-company-details","owner":"bitstarr","description":"Store and manage company details in the settings for site wide usage.","archived":false,"fork":false,"pushed_at":"2024-11-30T17:31:47.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-30T18:29:32.616Z","etag":null,"topics":["admin","grav","plugin","settings"],"latest_commit_sha":null,"homepage":"","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/bitstarr.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-08-14T13:37:52.000Z","updated_at":"2024-11-30T17:31:50.000Z","dependencies_parsed_at":"2024-10-17T21:15:09.251Z","dependency_job_id":"daf57f93-7ba5-44bf-be25-875867508555","html_url":"https://github.com/bitstarr/grav-plugin-company-details","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.5,"last_synced_commit":"c29dec0760cd5a57b3083c387576114fd50494e0"},"previous_names":["bitstarr/grav-plugin-company-details"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitstarr%2Fgrav-plugin-company-details","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitstarr%2Fgrav-plugin-company-details/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitstarr%2Fgrav-plugin-company-details/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitstarr%2Fgrav-plugin-company-details/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitstarr","download_url":"https://codeload.github.com/bitstarr/grav-plugin-company-details/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231136583,"owners_count":18333333,"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":["admin","grav","plugin","settings"],"created_at":"2024-10-01T14:24:34.188Z","updated_at":"2026-02-04T10:06:34.566Z","avatar_url":"https://github.com/bitstarr.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Company Details Plugin\n\nThe **Company Details** Plugin is an extension for [Grav CMS](https://github.com/getgrav/grav). Store and manage company details in the settings for site wide usage.\n\nIt will add a Details tab to the settings in the admin and will save this data as details.yaml in your config folder. This information will be served as `config.details` object in the frontend.\n\nAt the moment there a these options included.\n\n| Name | Type |\n|---|---|\n| Company Name | Text |\n| Email | Text |\n| Phone Number | Text |\n| Fax Number | Text |\n| Address | Textarea |\n| Google Maps URL | Text |\n| Opening Hours | List (Array) |\n| Opening Hours/Day | Text |\n| Opening Hours/Time Span | Text |\n\nIf you need more, modify it to your linking. This plugin is a simple base for customization and will not be published via GPM.\n\n## Installation\n\nThis Plugin will not be published via GPM because it's meant to be a building block of your custom theme.\n\n### Manual Installation dfrom zip file\n\nTo install the plugin manually, download the zip-version of this repository and unzip it under `/your/site/grav/user/plugins`. Then rename the folder to `company-details`. You can find these files on [GitHub](https://github.com/bitstarr/grav-plugin-company-details).\n\nYou should now have all the plugin files under\n\n    /your/site/grav/user/plugins/company-details\n\n### Manual Installation via git\n\nYou can use these commands to install the plugin:\n\n```\ncd /your/site/grav/user/plugins/\ngit clone https://github.com/bitstarr/grav-plugin-company-details company-details\nrm -rf company-details/.git\n```\n\nThe last command removes the git information from the plugin. You should include the plugin in you project repository directly so there is no need to have a connection to the original source and also versioning should be done project wide, especially if you modify the plugin.\n\n## Configuration\n\nBefore configuring this plugin, you should copy the `user/plugins/company-details/company-details.yaml` to `user/config/plugins/company-details.yaml` and only edit that copy.\n\nThere is not much more to configure that enable or disable the plugin.\n\n```yaml\nenabled: true\n```\n\nNote that if you use the Admin Plugin, a file with your configuration named company-details.yaml will be saved in the `user/config/plugins/`-folder once the configuration is saved in the Admin.\n\nIn `/your/site/grav/user/plugins/company-details` you find the configuration of the admin settings form. To modify or add fields, follow the [documentation about grav forms](https://learn.getgrav.org/17/forms).\n\n## Usage\n\nHere is an example (with [svg-extension](https://github.com/bitstarr/grav-plugin-svg-extension) for labeling) of what you can do with the stored information in your templates:\n\n```twig\n\u003cdiv class=\"aboutus\"\u003e\n    {% if config.details.address -%}\n    \u003cp\u003e\n        {{ config.details.name }}\u003cbr\u003e\n        {{ config.details.address|nl2br }}\n    \u003c/p\u003e\n    {% endif -%}\n\n    \u003cp\u003e\n        {% if config.details.phone -%}\n        {{ svg('phone', 'icon', { 'title': 'Telefon' })|raw }}\n        \u003ca href=\"tel:{{ config.details.phone|replace({' ': ''}) }}\" class=\"u-tel\"\u003e\n            {{ config.details.phone }}\n        \u003c/a\u003e\n        {% endif -%}\n        {% if config.details.email -%}\n        \u003cbr\u003e\n        {{ svg('mail', 'icon', { 'title': 'E-Mail' })|raw }}\n        \u003ca href=\"mailto:{{ config.details.email|safe_email }}\"\u003e\n            {{ config.details.email|safe_email }}\n        \u003c/a\u003e\n        {% endif -%}\n    \u003c/p\u003e\n\u003c/div\u003e\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitstarr%2Fgrav-plugin-company-details","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitstarr%2Fgrav-plugin-company-details","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitstarr%2Fgrav-plugin-company-details/lists"}