https://github.com/codeclutch-dev/oc-meta-plugin
Plugin providing meta information about website for October CMS
https://github.com/codeclutch-dev/oc-meta-plugin
laravel octobercms octobercms-plugin php wintercms wintercms-plugin
Last synced: 5 months ago
JSON representation
Plugin providing meta information about website for October CMS
- Host: GitHub
- URL: https://github.com/codeclutch-dev/oc-meta-plugin
- Owner: codeclutch-dev
- License: mit
- Created: 2021-07-08T23:52:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-15T22:44:53.000Z (almost 5 years ago)
- Last Synced: 2024-08-18T09:44:55.146Z (almost 2 years ago)
- Topics: laravel, octobercms, octobercms-plugin, php, wintercms, wintercms-plugin
- Language: PHP
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# October Meta Plugin
[](https://crowdin.com/project/oc-meta-plugin)
[](http://makeapullrequest.com)
[](https://opensource.org/licenses/MIT)
## Overview
Meta plugin is a base for websites made with October CMS by freelancers. This plugin should be compatible with Winter CMS too because it doesn't use any breaking changes October introduced.
With this plugin is possible:
* Set globally title of a page
* Upload a favicon, a logo and an OpenGraph protocol image
* Set globally meta keywords and meta color
* Make an easy copyright information
And the most important feature:
* Set website author signature and logo
## Installation
### Artisan
Use the Laravel's CLI. Traverse to a project's root directory and run the following:
```
php artisan plugin:install codeclutch.meta
```
### Composer
If you want to use Composer instead, run:
```
composer require codeclutch/meta-plugin
php artisan october:migrate
```
or for Winter CMS:
```
composer require codeclutch/meta-plugin
php artisan winter:up
```
## Documentation
### Copyright
If you want to add copyright information add component and write
>{% component 'signature' %}
### Head
Open layout.htm and in head tags leave only import of your style.css / app.css
Then import component and inside the head tag write
>{% component 'head' %}
### Logo
Wherever you want to use website logo, import component and write
>{% component 'logo' %}
(that's only an img)
### Signature
Open footer (or other file) to attach website author's signature in and import component, and then write
>{% component 'signature' %}
## Contributing
You are free to contribute in the following ways:
* sending pull requests
* bug reporting and feature requesting by creating issues on plugin [GitHub page](https://github.com/codeclutch-ltd/oc-meta-plugin/issues)
* localization to your language using [Crowdin](https://crowdin.com/project/oc-meta-plugin)
## License
The Meta plugin for October CMS is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).