Skip to content

Commit

Permalink
Update Readme (Install, Update, Usage)
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanMPierson committed Nov 17, 2014
1 parent 9c414eb commit 7f8f8e3
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 54 deletions.
119 changes: 65 additions & 54 deletions README.md
@@ -1,15 +1,28 @@
# Grav Highlight Plugin

![Highlight](assets/readme_1.png)

`highlight` is a [Grav](http://github.com/getgrav/grav) plugin that adds simple and powerful code highlighting functionality utilizing the jQuery plugin [Highlight.js](https://highlightjs.org/).

# 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 `highlight`.
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 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/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 `highlight`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-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/highlight
/your/site/grav/user/plugins/highlight

>> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav), the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) plugins, and a theme to be installed in order to operate.
Expand Down Expand Up @@ -74,57 +87,55 @@ You can also disable highlighting for a particular page if causes issues:

Valid theme options include:

```
arta
ascetic
atelier-dune.dark
atelier-dune.light
atelier-forest.dark
atelier-forest.light
atelier-heath.dark
atelier-heath.light
atelier-lakeside.dark
atelier-lakeside.light
atelier-seaside.dark
atelier-seaside.light
brown_paper
codepen-embed
color-brewer
dark
default
docco
far
foundation
github
googlecode
hybrid
idea
ir_black
kimbie.dark
kimbie.light
learn
magula
mono-blue
monokai_sublime
monokai
obsidian
paraiso.dark
paraiso.light
pojoaque
railscasts
rainbow
school_book
solarized_dark
solarized_light
sunburst
tomorrow-night-blue
tomorrow-night-bright
tomorrow-night-eighties
tomorrow-night
tomorrow
vs
xcode
zenburn
```
| | |
| :---------------------- | :--------------------- |
| arta | ascetic |
| atelier-dune.dark | atelier-dune.light |
| atelier-forest.dark | atelier-forest.light |
| atelier-heath.dark | atelier-heath.light |
| atelier-lakeside.dark | atelier-lakeside.light |
| atelier-seaside.dark | atelier-seaside.light |
| brown_paper | codepen-embed |
| color-brewer | dark |
| default | docco |
| far | foundation |
| github | googlecode |
| hybrid | idea |
| ir_black | kimbie.dark |
| kimbie.light | learn |
| magula | mono-blue |
| monokai_sublime | monokai |
| obsidian | paraiso.dark |
| paraiso.light | pojoaque |
| railscasts | rainbow |
| school_book | solarized_dark |
| solarized_light | sunburst |
| tomorrow-night-blue | tomorrow-night-bright |
| tomorrow-night-eighties | tomorrow-night |
| tomorrow | vs |
| xcode | zenburn |

> Note: If you want to see this plugin in action, have a look at [Grav Learn Site](http://learn.getgrav.org)
# Updating

As development for the Highlight plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Highlight is easy, and can be done through Grav's GPM system, as well as manually.

## GPM Update (Preferred)

The simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update highlight

This command will check your Grav install to see if your Highlight plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.

## Manual Update

Manually updating Highlight is pretty simple. Here is what you will need to do to get this done:

* Delete the `your/site/user/plugins/highlight` directory.
* Downalod the new version of the Highlight plugin from either [GitHub](https://github.com/getgrav/grav-plugin-highlight) or [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `highlight`.
* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.

> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.
Binary file added assets/readme_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7f8f8e3

Please sign in to comment.