You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

gitbook-plugin-include-highlight

Package Overview
Dependencies
Maintainers
2
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gitbook-plugin-include-highlight

Plugin for Gitbook for highlighting referenced files code

0.2.1
latest
Source
npmnpm
Version published
Weekly downloads
184
1.1%
Maintainers
2
Weekly downloads
 
Created
Source

gitbook-plugin-include-highlight

Highlight code in referenced source files.

This is heavy based on gitbook-plugin-include

Add !CODEFILE to your Markdown file with file path to your file that contains code. This will pre-process file contents and wrap them in in highlight code block.

Syntax will be picked up by file extension. example usage:

!CODEFILE "../../src/notSoAwsomeApp/file.ts"

gets file and displays code bloc highlight depending on file extension (TypeScript in this case).

Please note that file extension should match one of highlightjs css class

Install

Add to your book.json plugin list:

{
    "plugins" : [ "include-highlight" ],
}

Configuration

You can map file extensions that don't match syntax used in contents by adding a mapping in your book.json plugins config section:

"pluginsConfig": {
  "include-highlight": {
    "extensionToLanguage": {
      "ps1": "powershell"
    }
  }
}

The plugin is pre-configured with the following mappings:

{
	'feature': 'gherkin',
	'pde': 'processing',
	'ps1': 'powershell'
}

Keywords

gitbook

FAQs

Package last updated on 24 Nov 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts