Skip to content
This repository has been archived by the owner on Dec 16, 2021. It is now read-only.

A lightweight, easy-to-use and framework agnostic syntax highlighter for your code snippets.

License

Notifications You must be signed in to change notification settings

favware/syntax-highlighter

 
 

Repository files navigation

logo

Syntax Highlighter

A lightweight, easy-to-use and framework agnostic syntax highlighter for your code examples(snippets) in web applications

License Patreon

npm npm

Support Server


Table of Contents

Why yet another code highlighter?

There are many syntax highlighters available already but most of those are either complex to setup or front end framework specific. @favware/syntax-highlighter-core is built using StencilJS. You can use it everywhere, i.e. Angular, React, Vue, any framework, No Framework!

This is an adaptation of snippet-highlight from rahulbhooteshwar

Features

  • Uses PrismJS for syntax highlighting
  • Light and Dark mode supported
  • Copy code support
  • Supports many languages, see Supported Languages
  • Will default to using Fira Code as font family
    • The library first falls back to popular fonts such as Cascadia Code and Meslo NGF if it isn't available. If these are also not available it will go through various more popular coding fonts, ending in monospace

Demos

Angular

Edit Button

React

Edit Button

Vue

Edit Button

Supported Languages

To limit the size of this library a selection has been made from all langauges supported by PrismJS. The chosen languages are those that we consider the most popular / common. If you want to see another languages supported you're always free to open an issue

javascript, typescript, asciidoc, autohotkey, autoit, bash, batch,
 
c, clike, clojure, coffeescript, cpp, csharp, csp, css, dart,
 
diff, docker, elixir, gherkin, git, go, graphql, groovy, http,
 
ini, java, json, jsx, kotlin, less, lua, makefile, markdown,
 
nginx, objectivec, powershell, python, ruby, rust, sass, scala,
 
scss, sql, swift, tsx, vim, visual-basic, wasm, wiki, yaml

Screenshots

Dark Mode

Light Mode

About

A lightweight, easy-to-use and framework agnostic syntax highlighter for your code snippets.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • TypeScript 56.5%
  • CSS 30.1%
  • HTML 6.9%
  • JavaScript 6.1%
  • Shell 0.4%