https://github.com/fedonman/highlightjs-qsharp

This repository provides syntax highlighting for Microsoft's Q# language using highlight.js
https://github.com/fedonman/highlightjs-qsharp

highlightjs npm-package qsharp

Last synced: about 1 month ago
JSON representation

This repository provides syntax highlighting for Microsoft's Q# language using highlight.js

• Host: GitHub
• URL: https://github.com/fedonman/highlightjs-qsharp
• Owner: fedonman
• License: mit
• Created: 2021-02-14T22:36:56.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-05T02:42:03.000Z (over 3 years ago)
• Last Synced: 2024-11-14T21:14:12.276Z (about 2 months ago)
• Topics: highlightjs, npm-package, qsharp
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Q# syntax support for [highlight.js](https://highlightjs.org/)

[![NPM](https://nodei.co/npm/highlightjs-qsharp.png)](https://npmjs.org/package/highlightjs-qsharp)

This repository provides syntax highlighting for Microsoft's Q# language using highlight.js

## Usage

Simply include the Highlight.js library in your webpage or Node app, then load this module.

### Static website or simple usage

Simply load the module after loading highlight.js. You'll use the minified version found in the `dist` directory. This module is just a CDN build of the language, so it will register itself as the Javascript is loaded.

```html

 hljs.initHighlightingOnLoad(); 

```

This will find and highlight code inside of `
` tags; it tries to detect the language automatically. If automatic detection doesn’t work for you, you can specify the language in the `class` attribute:


```html


    

    ...

    



```


### Using directly from the UNPKG CDN

```html

```

- More info: 

### With Node or another build system

If you're using Node / Webpack / Rollup / Browserify, etc, simply require the language module, then register it with Highlight.js.

```javascript

var hljs = require('highlightjs');

var hljsQsharp = require('highlightjs-qsharp');

hljs.registerLanguage("qsharp", hljsQsharp);

hljs.initHighlightingOnLoad();

```

## License

hightlightjs-qsharp is released under the MIT License. See [LICENSE][1] file for details.

## Author

Vyron Vasileiadis 

## Links

- The official site for the Highlight.js library is .

- The Highlight.js GitHub project: 

- Learn more about Q#: 

[1]: https://github.com/fedonman/highlightjs-qsharp/blob/master/LICENSE