{"id":15290758,"url":"https://github.com/fedonman/highlightjs-qsharp","last_synced_at":"2026-01-05T20:05:31.235Z","repository":{"id":53139945,"uuid":"338916604","full_name":"fedonman/highlightjs-qsharp","owner":"fedonman","description":"This repository provides syntax highlighting for Microsoft's Q# language using highlight.js","archived":false,"fork":false,"pushed_at":"2021-04-05T02:42:03.000Z","size":13,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-02T20:47:39.603Z","etag":null,"topics":["highlightjs","npm-package","qsharp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fedonman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-14T22:36:56.000Z","updated_at":"2022-07-11T02:55:53.000Z","dependencies_parsed_at":"2022-09-05T07:50:11.406Z","dependency_job_id":null,"html_url":"https://github.com/fedonman/highlightjs-qsharp","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedonman%2Fhighlightjs-qsharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedonman%2Fhighlightjs-qsharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedonman%2Fhighlightjs-qsharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedonman%2Fhighlightjs-qsharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fedonman","download_url":"https://codeload.github.com/fedonman/highlightjs-qsharp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245232914,"owners_count":20581703,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["highlightjs","npm-package","qsharp"],"created_at":"2024-09-30T16:09:21.533Z","updated_at":"2026-01-05T20:05:31.170Z","avatar_url":"https://github.com/fedonman.png","language":"JavaScript","readme":"# Q# syntax support for [highlight.js](https://highlightjs.org/)\n\n[![NPM](https://nodei.co/npm/highlightjs-qsharp.png)](https://npmjs.org/package/highlightjs-qsharp)\n\nThis repository provides syntax highlighting for Microsoft's Q# language using highlight.js\n\n## Usage\n\nSimply include the Highlight.js library in your webpage or Node app, then load this module.\n\n### Static website or simple usage\n\nSimply 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.\n\n```html\n\u003cscript type=\"text/javascript\" src=\"/path/to/highlight.min.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"/path/to/highlightjs-qsharp/dist/qsharp.min.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\"\u003e hljs.initHighlightingOnLoad(); \u003c/script\u003e\n```\n\nThis will find and highlight code inside of `\u003cpre\u003e\u003ccode\u003e` 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:\n\n```html\n\u003cpre\u003e\n    \u003ccode class=\"qsharp\"\u003e\n    ...\n    \u003c/code\u003e\n\u003c/pre\u003e\n```\n\n### Using directly from the UNPKG CDN\n\n```html\n\u003cscript type=\"text/javascript\" src=\"https://unpkg.com/highlightjs-qsharp/dist/qsharp.min.js\"\u003e\u003c/script\u003e\n```\n\n- More info: \u003chttps://unpkg.com\u003e\n\n### With Node or another build system\n\nIf you're using Node / Webpack / Rollup / Browserify, etc, simply require the language module, then register it with Highlight.js.\n\n```javascript\nvar hljs = require('highlightjs');\nvar hljsQsharp = require('highlightjs-qsharp');\n\nhljs.registerLanguage(\"qsharp\", hljsQsharp);\nhljs.initHighlightingOnLoad();\n```\n\n## License\n\nhightlightjs-qsharp is released under the MIT License. See [LICENSE][1] file for details.\n\n## Author\n\nVyron Vasileiadis \u003chi@fedonman.com\u003e\n\n## Links\n\n- The official site for the Highlight.js library is \u003chttps://highlightjs.org/\u003e.\n- The Highlight.js GitHub project: \u003chttps://github.com/highlightjs/highlight.js\u003e\n- Learn more about Q#: \u003chttps://docs.microsoft.com/en-us/azure/quantum/user-guide/\u003e\n\n[1]: https://github.com/fedonman/highlightjs-qsharp/blob/master/LICENSE\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedonman%2Fhighlightjs-qsharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffedonman%2Fhighlightjs-qsharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedonman%2Fhighlightjs-qsharp/lists"}