Download the PHP package spatie/shiki-php without Composer

On this page you can find all versions of the php package spatie/shiki-php. 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?

Example code of spatie/shiki-php

Informations about the package shiki-php

Code highlighting with Shiki in PHP

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Shiki is a beautiful syntax highlighter powered by the same language engine that many code editors use. This package allows you to use Shiki from PHP.

This package also ships with the following extra languages, on top of the 100+ that Shiki supports out of the box:

Usage in Laravel and league/commonmark

Laravel users can easily use Shiki via our spatie/laravel-markdown package.

If you need a league/commonmark extension to highlight code, head over to spatie/commonmark-shiki-highlighter.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

In your project, you must have the JavaScript package shiki installed, otherwise the <pre> element will not be present in the output.

You can install it via npm

... or Yarn.

Make sure you have installed Node 10 or higher.

Usage

Here's an example where we are going to highlight some PHP code.

The output is this chunk of HTML which will render beautifully in the browser:

Marking lines as highlighted, added, deleted or focus

Shiki-php allows you to mark certain lines as highlighted, added, deleted and focus. To do this, you can pass in the necessary lines to the highlight method:

You can then target these classes in your own CSS to color these lines how you want.

PHP 7.4 support

Shiki has a nice and easy syntax in combination with at least PHP 8.

It does support PHP 7.4, but does loose a little bit of it's nice syntax if using it with PHP7.4, as you need to follow the order of the variables.

Determining available languages

To get an array with all languages that Shiki supports, call getAvailableLanguages

Determining available themes

To get an array with all themes that Shiki supports, call getAvailableThemes

Using a custom theme

Shiki supports any VSCode themes.

You can load a theme simply by passing an absolute path as the theme parameter.

Using Node Version Manager

Under the hood, this package runs a node command to render the markdown. If you use NVM during development, then the package will be unlikely to find your version of node as it looks for the node executable in /usr/local/bin and /opt/homebrew/bin - if this is the case, then you should create a symlink between the node distributable in your NVM folder, to that of the usr/local/bin. Such a command might look like this:

Creating this symlink will allow the package to find your NPM executable. Please note, if you change your NPM version you will have to update your symlinks accordingly.

Testing

You can run all the tests with this command:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

The Blade syntax highlighting source is taken from this repo.
The Antlers syntax highlighting source is taken from this repo.

Alternatives

If you don't want to install and handle Shiki yourself, take a look at Torchlight, which can highlight your code with minimal setup.

License

The MIT License (MIT). Please see License File for more information.

All versions of shiki-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
ext-json Version *
symfony/process Version ^5.4|^6.4|^7.1
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 spatie/shiki-php contains the following files

Loading the files please wait ....