8000 GitHub - bobril/highlighter: Syntax highlighter component for Bobril
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bobril/highlighter

Repository files navigation

Bobril Highlighter

Bobril component for syntax highlighting of source code. For actual work uses highlight.js.

npm version

Demo

Updated to use version 11.9.0 of highlight.js.

How to use

import * as b from "bobril";
import * as high from "@bobril/highlighter";
import { docco } from "@bobril/highlighter/styles";

b.init(() => <high.Highlighter style={docco}>{`let actual = "code " + "shine";`}</high.Highlighter>);

By default only most common languages are registered. If all are needed use this:

import "@bobril/highlighter/allLanguages";

Props of component

  • language?: string - if not provided then autodetect (slower)
  • style?: HighlightStyle - provide theme to use for styling
  • showLineNumbers?: boolean - default is true
  • startingLineNumber?: number - default is 1, NaN is automatically set to 1 as well.
  • lineStyle?: ((line: number) => b.IBobrilStyles) | undefined - allow style div for each line
  • lineContentStyle?: ((line: number) => b.IBobrilStyles) | undefined - allow to style div of line content without line number
  • lineNumberStyle?: ((largestLineNumber: number, style: HighlightStyle) => (line: number) => b.IBobrilStyles) | undefined - allows complete override of default line number style
  • children?: string - only one string child is allowed and it must contain code to format

Acknowledges

  • highlight.js - actual ground work
  • lowlight - for Emitter Tree approach
  • react-syntax-highlighter - scripts and inspirations in line number styling

About

Syntax highlighter component for Bobril

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0