Skip to content

AdamPerkins/vue3-highlightjs

This branch is up to date with Daizhen1995/vue3-highlightjs:main.

Folders and files

NameName
Last commit message
Last commit date
Nov 17, 2020
Nov 11, 2020
Nov 11, 2020
Nov 11, 2020
Nov 11, 2020
Nov 11, 2020
Nov 11, 2020
Nov 12, 2020
Nov 17, 2020
Nov 11, 2020
Nov 17, 2020
Nov 17, 2020

Repository files navigation

vue3-highlightjs

Vue.js 3.x syntax highlighting made easy, using highlight.js.

Quickstart

Install

npm install --save vue3-highlightjs or use dist/vue3-highlight.min.js

Usage

For vue-cli/vite user:

import { createApp } from 'vue'
import VueHighlightJS from 'vue3-highlightjs'
import 'highlight.js/styles/solarized-light.css'

const app = createApp({})

app.use(VueHighlightJS)

For standalone usage:

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.3.2/styles/default.min.css" />
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.0.2/vue.global.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script>
<script src="../dist/vue3-highlight.js"></script>

Sample

In Vue sfc

<pre v-highlightjs="sourcecode"><code class="javascript"></code></pre>

<pre v-highlightjs><code class="javascript">const s = new Date().toString()</code></pre>

In html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.3.2/styles/default.min.css" />
  </head>

  <body>
    <div id="app">
      <pre v-highlightjs><code class="javascript">const s = new Date().toString()</code></pre>
    </div>
    <script src="https://cdn.bootcdn.net/ajax/libs/vue/3.0.2/vue.global.js"></script>
    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.3.2/highlight.min.js"></script>
    <script src="../dist/vue3-highlight.js"></script>
    <script>
      Vue.createApp({}).use(Vue3Highlightjs).mount('#app')
    </script>
  </body>
</html>

About

Syntax highlighting with highlight.js for Vue.js 3.x

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 98.1%
  • JavaScript 1.9%