highlightjs/highlightjs-vue

Please add vue.d.ts

patarapolw opened this issue · 0 comments

So that it can be easily used in TypeScript.

You might add "types": "vue.d.ts" to package.json.

And vue.d.ts might be simply, (You might need to add @types/highlight.js to dependencies)

import hljs from "highlight.js";

export = hljsDefineVue;

/**
 * Add Vue styling to highlight.js
 * @param hljs 
 */
function hljsDefineVue(hljs: hljs.HLJSStatic): void;

namespace hljsDefineVue {
  /**
   * Manually add Vue styling to highlight.js
   * 
   * ```typescript
   * import hljs from "highlight.js"
   * hljs.registerLanguage("vue", hljsDefineVue)
   * ```
   * @param hljs 
   */
  function definer(hljs: hljs.HLJSStatic): hljs.IModeBase;
}

Also, README.md is wrong here,

If you're using webpack / rollup / browserify / node:

var hljs = require('highlightjs');
var hljsDefineCshtmlRazor = require('highlightjs-vue');