Download the PHP package s1syphos/kirby3-highlight without Composer

On this page you can find all versions of the php package s1syphos/kirby3-highlight. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kirby3-highlight

Kirby3 Highlight

Release License Issues

This plugin highlights your code snippets server-side - without external dependencies.

Table of contents

Getting started

Use one of the following methods to install & use kirby3-highlight:

Git submodule

If you know your way around Git, you can download this plugin as a submodule:

Composer

Clone or download

  1. Clone or download this repository.
  2. Unzip / Move the folder to site/plugins.

Now proper classes are added to your code snippets, making them 'themeable'. In order to do so, head over to the styling section.

Configuration

Change kirby-highlight options to suit your needs:

Option Type Default Description
s1syphos.highlight.class String 'hljs' Adds one or more classes to the preceding pre element.
s1syphos.highlight.languages Array ['html', 'php'] Defines languages to be auto-detected (currently 176 languages are supported).
s1syphos.highlight.escaping Boolean false Enables character escaping (converting < to &lt;, > to &gt;, ..), see htmlspecialchars() docs.

Styling

All highlight.js styles are fully compatible with kirby3-highlight. Just include it using the css() helper:

Troubleshooting

If in doubt, check the correct spelling of the language in question - doing otherwise might break kirbytext().

Credits / License

kirby3-highlight is based on Geert Bergman's highlight.php library (a PHP port of highlight.js). It is licensed under the buy a license.

Special Thanks

I'd like to thank everybody that's making great software - you people are awesome. Also I'm always thankful for feedback and bug reports :)

All versions of kirby3-highlight with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.1
scrivo/highlight.php Version ^9.15
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package s1syphos/kirby3-highlight contains the following files

Loading the files please wait ....