🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

gitbook-plugin-include-highlight

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
g

gitbook-plugin-include-highlight

Plugin for Gitbook for highlighting referenced files code

0.2.1
latest
69

Supply Chain Security

100

Vulnerability

77

Quality

78

Maintenance

100

License

Unpopular package

Quality

This package is not very popular.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

Found 2 instances in 1 package

Version published
Weekly downloads
80
-50.31%
Maintainers
2
Weekly downloads
 
Created
Issues
3

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'
}

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