Giter VIP home page Giter VIP logo

quaint-highlight's Introduction

quaint-highlight

Highlight code in Quaint markup using highlight.js.

Install

quaint --setup highlight

Follow the instructions.

Sample configuration

This configuration entry must be added in the plugins field of quaint.json:

"highlight": {
  "theme": "agate",
  "defaultBlock": "javascript",
  "defaultInline": "javascript",
  "operatorBlock": "&",
  "operatorInline": "`"
}

Options

operatorBlock (default: "&") - define the operator for block highlighting.

operatorInline (default: "`") - define the operator for inline highlighting.

defaultLanguage (default: null) - define the language to use for highlighting by default. This is useful if most of your code blocks are in a specific language. By default, there is no highlighting. Note that this will highlight both code blocks and inline code.

defaultBlock (default: null) - define the language to use for highlighting by default for code blocks.

defaultInline (default: null) - define the language to use for highlighting by default for inline code.

installPlugins (default: null) - a function that will be called on the highlight.js instance. You can configure it, add languages, and so on.

theme (default: "default") - the theme to use. See here for a demo of the themes.

You can also use a custom theme if you wish. If the theme name ends with .css, quaint-highlight will assume it is a path to the css file to use.

quaint-highlight's People

Contributors

breuleux avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.