Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Iain S Gillis committed Nov 12, 2021
0 parents commit ca46b6c
Show file tree
Hide file tree
Showing 21 changed files with 1,363 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# v0.1.0
## 11/12/2021

1. [](#new)
* ChangeLog started...
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2021 Iain Gillis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Highlight Php Plugin

**This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.**

The **Highlight Php** Plugin is an extension for [Grav CMS](http://github.com/getgrav/grav). Server-side syntax highlighting (i.e., without JavaScript) using the [highlight.php](https://github.com/scrivo/highlight.php) library

## Installation

Installing the Highlight Php 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.

### GPM Installation (Preferred)

To install the plugin via the [GPM](http://learn.getgrav.org/advanced/grav-gpm), through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:

bin/gpm install highlight-php

This will install the Highlight Php plugin into your `/user/plugins`-directory within Grav. Its files can be found under `/your/site/grav/user/plugins/highlight-php`.

### Manual Installation

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 `highlight-php`. You can find these files on [GitHub](https://github.com/iainsgillis/grav-plugin-highlight-php) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).

You should now have all the plugin files under

/your/site/grav/user/plugins/highlight-php

> 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/iainsgillis/grav-plugin-highlight-php/blob/master/blueprints.yaml).
### Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the `Plugins`-menu and clicking on the `Add` button.

## Configuration

Before configuring this plugin, you should copy the `user/plugins/highlight-php/highlight-php.yaml` to `user/config/plugins/highlight-php.yaml` and only edit that copy.

Here is the default configuration and an explanation of available options:

```yaml
enabled: true
```

Note that if you use the Admin Plugin, a file with your configuration named highlight-php.yaml will be saved in the `user/config/plugins/`-folder once the configuration is saved in the Admin.

## Usage

**Describe how to use the plugin.**

## Credits

**Did you incorporate third-party code? Want to thank somebody?**

## To Do

- [ ] Future plans, if any

36 changes: 36 additions & 0 deletions blueprints.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Highlight Php
slug: highlight-php
type: plugin
version: 0.1.0
description: Server-side syntax highlighting (i.e., without JavaScript) using the [highlight.php](https://github.com/scrivo/highlight.php) library
icon: plug
author:
name: Iain Gillis
email: iain@iainsgillis.com
homepage: https://github.com/iainsgillis/grav-plugin-highlight-php
demo: http://demo.yoursite.com
keywords: grav, plugin, etc
bugs: https://github.com/iainsgillis/grav-plugin-highlight-php/issues
docs: https://github.com/iainsgillis/grav-plugin-highlight-php/blob/develop/README.md
license: MIT

dependencies:
- { name: grav, version: '>=1.6.0' }

form:
validation: loose
fields:
enabled:
type: toggle
label: PLUGIN_ADMIN.PLUGIN_STATUS
highlight: 1
default: 0
options:
1: PLUGIN_ADMIN.ENABLED
0: PLUGIN_ADMIN.DISABLED
validate:
type: bool
text_var:
type: text
label: PLUGIN_HIGHLIGHT_PHP.TEXT_VARIABLE
help: PLUGIN_HIGHLIGHT_PHP.TEXT_VARIABLE_HELP
29 changes: 29 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "iainsgillis/highlight-php",
"type": "grav-plugin",
"description": "Server-side syntax highlighting (i.e., without JavaScript) using the [highlight.php](https://github.com/scrivo/highlight.php) library",
"keywords": ["plugin"],
"homepage": "https://github.com/iainsgillis/grav-plugin-highlight-php",
"license": "MIT",
"authors": [
{
"name": "Iain Gillis",
"email": "iain@iainsgillis.com",
"role": "Developer"
}
],
"require": {
"php": ">=7.1.3"
},
"autoload": {
"psr-4": {
"Grav\\Plugin\\HighlightPhp\\": "classes/"
},
"classmap": ["highlight-php.php"]
},
"config": {
"platform": {
"php": "7.1.3"
}
}
}
23 changes: 23 additions & 0 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

59 changes: 59 additions & 0 deletions highlight-php.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php
namespace Grav\Plugin;

use Composer\Autoload\ClassLoader;
use Grav\Common\Plugin;

/**
* Class HighlightPhpPlugin
* @package Grav\Plugin
*/
class HighlightPhpPlugin extends Plugin
{
/**
* @return array
*
* The getSubscribedEvents() gives the core a list of events
* that the plugin wants to listen to. The key of each
* array section is the event that the plugin listens to
* and the value (in the form of an array) contains the
* callable (or function) as well as the priority. The
* higher the number the higher the priority.
*/
public static function getSubscribedEvents(): array
{
return [
'onPluginsInitialized' => [
// Uncomment following line when plugin requires Grav < 1.7
// ['autoload', 100000],
['onPluginsInitialized', 0]
]
];
}

/**
* Composer autoload
*
* @return ClassLoader
*/
public function autoload(): ClassLoader
{
return require __DIR__ . '/vendor/autoload.php';
}

/**
* Initialize the plugin
*/
public function onPluginsInitialized(): void
{
// Don't proceed if we are in the admin plugin
if ($this->isAdmin()) {
return;
}

// Enable the main events we are interested in
$this->enable([
// Put your main events here
]);
}
}
2 changes: 2 additions & 0 deletions highlight-php.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
enabled: true
text_var: Custom Text added by the **Highlight Php** plugin (disable plugin to remove)
4 changes: 4 additions & 0 deletions languages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
en:
PLUGIN_HIGHLIGHT_PHP:
TEXT_VARIABLE: Text Variable
TEXT_VARIABLE_HELP: Text to add to the top of a page
7 changes: 7 additions & 0 deletions vendor/autoload.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

// autoload.php @generated by Composer

require_once __DIR__ . '/composer/autoload_real.php';

return ComposerAutoloaderInit61b57ed6dfbb65cd70f7b41ac33678ff::getLoader();
Loading

0 comments on commit ca46b6c

Please sign in to comment.