Download the PHP package hashtagerrors/syntax-highlighter without Composer
On this page you can find all versions of the php package hashtagerrors/syntax-highlighter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hashtagerrors/syntax-highlighter
More information about hashtagerrors/syntax-highlighter
Files in hashtagerrors/syntax-highlighter
Package syntax-highlighter
Short Description The power of Prism syntax highlighting in Craft
License MIT
Informations about the package syntax-highlighter
Syntax Highlighter
The power of Prism syntax highlighting in Craft.
Requirements
This plugin requires Craft CMS 3.0.0 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require hashtagerrors/syntax-highlighter
- In the Control Panel, go to Settings → Plugins and click the “Install” button for Syntax Highlighter.
Syntax Highlighter Overview
Syntax Highlighter Setting
Prism is one of the most popular syntax highlighters that widely used by a lot of blog or websites due to it's ability to do custom builds of the language highlighter and plugins you want to be used.
This plugin helps you to similarly build Prism files by selecting desired languages, plugins and theme and then finally bring code highlighter in frontend with a single line of code.
Plugin setting page has 178 languages, 8 themes & 4 plugins to select from. Once you choose desired languages, theme and plugins, the plugin builds a JS and CSS file based on the selection which is then automatically fetched when called in frontend.
Syntax Highlighter Field
The plugin adds a Syntax Highlighter
fieldtype which then displays a block to add your code, select code type, add a caption and specify the lines to be highlighted (if enabled in plugin setting).
Syntax Highlighter Frontend
Using{{ craft.syntaxHighlighter.render(entry.fieldHandle) }}
in template will show the highlighted code in the frontend.
Configuring Syntax Highlighter
The Plugin has following settings:
Choose Languages (Required)
Choose the Languages that should be enabled. As this is a required field atleast 1 language needs to be selected.
Default Markup, CSS, C-like, JavaScript, Twig
.
Default Language
The language that would be selected by default in the drop down menu in Code Block Field.
Default Twig
Theme
The Prism theme you would like to enable in frontend.
Default Prism
Line Numbers
To enable Line Numbers in the code block. Default
Default Prism
Line Highlight
To enable Line Highlight in the code block.
Default True
Show Language
To show language used in the code block.
Default False
Copy to Clipboard Button
To enable Copy to Clipboard Button
Default True
Max Height
To set maximum height(in px) of code container to avoid long scrolling in case of long code.
Default 500
Leave empty or enter 0 to disable scroll.
NOTE: Since this plugin build files every time it's plugin setting is saved, the plugin directory should have Write permission. specifically for thehashtagerrors\syntax-highlighter\src\assetbundles\syntaxhighlighterfrontend
folder.
Using Syntax Highlighter
- Select desired languages, theme and plugin from setting page.
- Create a new field with
Syntax Highlighter
fieldtype. - Add field in your section.
- Copy Paste or write down your code in the textarea of the the Code block,
- Select language from the Code Type dropdown.
- Enter line number(s) to be highlighted (if enabled in plugin setting).
- Add a Caption to show a text on below code block (optional).
- Use
{{ craft.syntaxHighlighter.render(entry.fieldHandle) }}
in template to show highlighted code.
Syntax Highlighter Roadmap
- Ability to add custom CSS by user.
- Prism's File Highlight plugin.
- Prism's Other plugins.
New ideas are always welcome. You can post your ideas, requrest or issue here
Loved It?
Show your Love and Support by buying me a cup of Coffee !
Brought to you by Hashtag Errors