Skouter mortgage estimates. Web application with view written in PHP and Vue, but controller and models in Go.
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.

README.md.twig 2.8 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. {% set component_title = (component.name|titleize) %}
  2. {% set component_hyphenated = (component.name|hyphenize) %}
  3. {% set developer_hyphenated = (component.author.githubid|hyphenize) %}
  4. # {{ component_title }} Plugin
  5. **This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.**
  6. The **{{ component_title }}** Plugin is an extension for [Grav CMS](https://github.com/getgrav/grav). {{ component.description }}
  7. ## Installation
  8. Installing the {{ component_title }} plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.
  9. ### GPM Installation (Preferred)
  10. To install the plugin via the [GPM](https://learn.getgrav.org/cli-console/grav-cli-gpm), through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:
  11. bin/gpm install {{ component_hyphenated }}
  12. This will install the {{ component_title }} plugin into your `/user/plugins`-directory within Grav. Its files can be found under `/your/site/grav/user/plugins/{{ component_hyphenated }}`.
  13. ### Manual Installation
  14. To 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 `{{ component_hyphenated }}`. You can find these files on [GitHub](https://github.com/{{ developer_hyphenated }}/grav-plugin-{{ component_hyphenated }}) or via [GetGrav.org](https://getgrav.org/downloads/plugins).
  15. You should now have all the plugin files under
  16. /your/site/grav/user/plugins/{{ component_hyphenated }}
  17. > NOTE: This plugin is a modular component for Grav which may require other plugins to operate, please see its [blueprints.yaml-file on GitHub](https://github.com/{{ developer_hyphenated }}/grav-plugin-{{ component_hyphenated }}/blob/main/blueprints.yaml).
  18. ### Admin Plugin
  19. If you use the Admin Plugin, you can install the plugin directly by browsing the `Plugins`-menu and clicking on the `Add` button.
  20. ## Configuration
  21. Before configuring this plugin, you should copy the `user/plugins/{{ component_hyphenated }}/{{ component_hyphenated }}.yaml` to `user/config/plugins/{{ component_hyphenated }}.yaml` and only edit that copy.
  22. Here is the default configuration and an explanation of available options:
  23. ```yaml
  24. enabled: true
  25. ```
  26. Note that if you use the Admin Plugin, a file with your configuration named {{component_hyphenated}}.yaml will be saved in the `user/config/plugins/`-folder once the configuration is saved in the Admin.
  27. ## Usage
  28. **Describe how to use the plugin.**
  29. ## Credits
  30. **Did you incorporate third-party code? Want to thank somebody?**
  31. ## To Do
  32. - [ ] Future plans, if any