initial commit

CHANGELOG.md

@@ -0,0 +1,5 @@
+# v1.0.0
+## mm/dd/2019
+
+1. [](#new)
+    * Initial Version

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Grav, PrismJS
+
+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.

README.md

@@ -1 +1,295 @@
-# grav-plugin-prism-highlight
+# Grav Prism Highlighter Plugin
+
+`Prism Highlighter` is a [Grav](http://github.com/getgrav/grav) plugin that adds simple and powerful code highlighting functionality utilizing the [Prism.js](http://prismjs.com/) syntax highlighter.
+
+# Installation
+
+Installing the Highlight plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file. 
+
+## GPM Installation (Preferred)
+
+The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line).  From the root of your Grav install type:
+
+    bin/gpm install prism-highlight
+
+This will install the Highlight plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/prism-highlight`.
+
+## Manual Installation
+
+To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `prism-highlight`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-prism-highlight) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
+
+You should now have all the plugin files under
+
+    /your/site/grav/user/plugins/prism-highlight
+
+
+# Languages included
+
+Prism.js supports currently [176 languages](http://prismjs.com/#languages-list), at the time of this edit, but the ones included in this specific version is:
+
+* markup
+* html
+* xml
+* svg
+* mathml
+* css
+* css-extras
+* c-lik
+* javascript, js
+* apache
+* bash
+* sh
+* coffee
+* diff
+* docker
+* git
+* go
+* java
+* json
+* json5
+* less
+* lua
+* markdown
+* php
+* php-extras
+* python
+* regex
+* ruby
+* sass
+* scss
+* sql
+* twig
+* yaml
+
+# Plugins Included
+
+This build of Prism also includes the following plugins:
+
+* Line Highlight
+* Line Numbers
+* Command Line
+* Toolbar
+* Copy to Clipboard
+
+# Basic Usage
+
+In your markdown, you can create a block of code, and assign the language to it. You can choose between the list above. Example:
+
+```
+```php
+<?php
+
+namespace Grav\Plugin;
+
+use \Grav\Common\Plugin;
+use \Grav\Common\Grav;
+use \Grav\Common\Page\Page;
+
+class PrismHighlightPlugin extends Plugin
+{
+    /**
+     * @return array
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            'onPageInitialized' => ['onPageInitialized', 0],
+            'onShortcodeHandlers' => ['onShortcodeHandlers', 0],
+            'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
+        ];
+    }
+}
+```
+```
+
+# Advanced Usage
+
+To get access to advanced options that can be set individually, you can use the included `[prism][/prism]` shortcode:
+
+```
+[prism classes="language-twig line-numbers"]
+{% set payload = {frontmatter: page.header, content: page.content}  %}
+{{ payload|json_encode|raw }}
+[/prism]
+```
+
+```
+[prism classes="language-bash command-line" cl-prompt="\[foo@localhost\] $"]
+cd ~/webroot
+git clone -b master https://github.com/getgrav/grav.git
+[/prism]
+```
+
+... more to come ...
+
+# Configuration
+
+Configuration shall be set in `config/plugins/prism-highlight.yaml`.
+
+```yaml
+enabled: true
+theme: prism-base16-ocean.dark.css
+all-pre-blocks: true
+plugins:
+    line-numbers: false
+    command-line: false
+    command-line-prompt: '$'
+```
+
+You can also override the default theme for a page with the option `theme`:
+
+```
+base16-duotone-dark.dark.css
+base16-duotone-dark.light.css
+base16-duotone-darkdesert.dark.css
+base16-duotone-darkearth.dark.css
+base16-duotone-darkearth.light.css
+base16-duotone-darkforest.dark.css
+base16-duotone-darkforest.light.css
+base16-duotone-darkpark.dark.css
+base16-duotone-darkpool.dark.css
+base16-duotone-darkpool.light.css
+base16-duotone-darksea.dark.css
+base16-duotone-darksea.light.css
+base16-duotone-darkspace.dark.css
+base16-duotone-darkspace.light.css
+prism-atelier-cave-dark.css
+prism-atelier-cave-light.css
+prism-atelier-dune-dark.css
+prism-atelier-dune-light.css
+prism-atelier-estuary-dark.css
+prism-atelier-estuary-light.css
+prism-atelier-forest-dark.css
+prism-atelier-forest-light.css
+prism-atelier-heath-dark.css
+prism-atelier-heath-light.css
+prism-atelier-lakeside-dark.css
+prism-atelier-lakeside-light.css
+prism-atelier-plateau-dark.css
+prism-atelier-plateau-light.css
+prism-atelier-savanna-dark.css
+prism-atelier-savanna-light.css
+prism-atelier-seaside-dark.css
+prism-atelier-seaside-light.css
+prism-atelier-sulphurpool-dark.css
+prism-atelier-sulphurpool-light.css
+prism-atom-dark.css
+prism-base2tone-cave-dark.css
+prism-base2tone-cave-light.css
+prism-base2tone-desert-dark.css
+prism-base2tone-desert-light.css
+prism-base2tone-drawbridge-dark.css
+prism-base2tone-drawbridge-light.css
+prism-base2tone-earth-dark.css
+prism-base2tone-earth-light.css
+prism-base2tone-evening-dark.css
+prism-base2tone-evening-light.css
+prism-base2tone-forest-dark.css
+prism-base2tone-forest-light.css
+prism-base2tone-heath-dark.css
+prism-base2tone-heath-light.css
+prism-base2tone-lake-dark.css
+prism-base2tone-lake-light.css
+prism-base2tone-meadow-dark.css
+prism-base2tone-meadow-light.css
+prism-base2tone-morning-dark.css
+prism-base2tone-morning-light.css
+prism-base2tone-pool-dark.css
+prism-base2tone-pool-light.css
+prism-base2tone-sea-dark.css
+prism-base2tone-sea-light.css
+prism-base2tone-space-dark.css
+prism-base2tone-space-light.css
+prism-base2tone-suburb-dark.css
+prism-base2tone-suburb-light.css
+prism-base16-3024.dark.css
+prism-base16-3024.light.css
+prism-base16-apathy.dark.css
+prism-base16-apathy.light.css
+prism-base16-ashes.dark.css
+prism-base16-ashes.light.css
+prism-base16-ateliercave.dark.css
+prism-base16-ateliercave.light.css
+prism-base16-atelierdune.dark.css
+prism-base16-atelierdune.light.css
+prism-base16-atelierestuary.dark.css
+prism-base16-atelierestuary.light.css
+prism-base16-atelierforest.dark.css
+prism-base16-atelierforest.light.css
+prism-base16-atelierheath.dark.css
+prism-base16-atelierheath.light.css
+prism-base16-atelierlakeside.dark.css
+prism-base16-atelierlakeside.light.css
+prism-base16-atelierplateau.dark.css
+prism-base16-atelierplateau.light.css
+prism-base16-ateliersavanna.dark.css
+prism-base16-ateliersavanna.light.css
+prism-base16-atelierseaside.dark.css
+prism-base16-atelierseaside.light.css
+prism-base16-ateliersulpherpool.dark.css
+prism-base16-ateliersulpherpool.light.css
+prism-base16-ateliersulphurpool.dark.css
+prism-base16-ateliersulphurpool.light.css
+prism-base16-bespin.dark.css
+prism-base16-bespin.light.css
+prism-base16-brewer.dark.css
+prism-base16-brewer.light.css
+prism-base16-bright.dark.css
+prism-base16-bright.light.css
+prism-base16-chalk.dark.css
+prism-base16-chalk.light.css
+prism-base16-codeschool.dark.css
+prism-base16-codeschool.light.css
+prism-base16-colors.dark.css
+prism-base16-colors.light.css
+prism-base16-default.dark.css
+prism-base16-default.light.css
+prism-base16-eighties.dark.css
+prism-base16-eighties.light.css
+prism-base16-embers.dark.css
+prism-base16-embers.light.css
+prism-base16-flat.dark.css
+prism-base16-flat.light.css
+prism-base16-google.dark.css
+prism-base16-google.light.css
+prism-base16-grayscale.dark.css
+prism-base16-grayscale.light.css
+prism-base16-greenscreen.dark.css
+prism-base16-greenscreen.light.css
+prism-base16-harmonic16.dark.css
+prism-base16-harmonic16.light.css
+prism-base16-hopscotch.dark.css
+prism-base16-hopscotch.light.css
+prism-base16-isotope.dark.css
+prism-base16-isotope.light.css
+prism-base16-londontube.dark.css
+prism-base16-londontube.light.css
+prism-base16-marrakesh.dark.css
+prism-base16-marrakesh.light.css
+prism-base16-mocha.dark.css
+prism-base16-mocha.light.css
+prism-base16-monokai.dark.css
+prism-base16-monokai.light.css
+prism-base16-ocean.dark.css
+prism-base16-ocean.light.css
+prism-base16-paraiso.dark.css
+prism-base16-paraiso.light.css
+prism-base16-pop.dark.css
+prism-base16-pop.light.css
+prism-base16-railscasts.dark.css
+prism-base16-railscasts.light.css
+prism-base16-shapeshifter.dark.css
+prism-base16-shapeshifter.light.css
+prism-base16-solarized.dark.css
+prism-base16-solarized.light.css
+prism-base16-summerfruit.dark.css
+prism-base16-summerfruit.light.css
+prism-base16-tomorrow.dark.css
+prism-base16-tomorrow.light.css
+prism-base16-twilight.dark.css
+prism-base16-twilight.light.css
+```
+
+Check out a [live test](http://prismjs.com/test.html) or a [live demo](http://prismjs.com/index.html#examples).
+
+

blueprints.yaml

@@ -0,0 +1,35 @@
+name: Prism Highlighter
+version: 1.0.0
+description: "This plugin provides code highlighting functionality via the [Prism.js](http://prismjs.com/) syntax highlighter."
+icon: code
+author:
+    name: Team Grav
+    email: [email protected]
+    url: http://getgrav.org
+homepage: https://github.com/getgrav/grav-prism-highlight
+keywords: highlight, plugin, code, prism
+bugs: https://github.com/getgrav/grav-prism-highlight/issues
+license: MIT
+
+form:
+  validation: strict
+  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
+
+    theme:
+      type: select
+      label: CSS Theme
+      default: prism-base16-ocean.dark.css
+      size: large
+      data-options@: '\Grav\Plugin\PrismHighlightPlugin::themeOptions'
+
+