BoomMicrophone/nixpkgs-suyu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

documentation-highlighter: 9.12.0 -> 11.9.0, add new langs

Browse source 
this has been overdue for a while. we also add the `shell` language to
the bundle (in addition to nix and bash) for ShellSession highlighting.

perhaps we should use the full, regular distribution instead of a custom
build, but eh.
This commit is contained in:
pennae 2023-12-01 18:33:47 +01:00
parent 548f98f4fb
commit 3bf6d6d251
7 changed files with 427 additions and 183 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.editorconfig
View file

@ -90,6 +90,9 @@ insert_final_newline = unset
indent_style = unset indent_style = unset
trim_trailing_whitespace = unset trim_trailing_whitespace = unset
[pkgs/misc/documentation-highlighter/**]
insert_final_newline = unset
[pkgs/servers/dict/wordnet_structures.py] [pkgs/servers/dict/wordnet_structures.py]
trim_trailing_whitespace = unset trim_trailing_whitespace = unset

43
pkgs/misc/documentation-highlighter/LICENSE
View file

@ -1,24 +1,29 @@
Copyright (c) 2006, Ivan Sagalaev BSD 3-Clause License
Copyright (c) 2006, Ivan Sagalaev.
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright * Redistributions of source code must retain the above copyright notice, this
notice, this list of conditions and the following disclaimer. list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of highlight.js nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY * Redistributions in binary form must reproduce the above copyright notice,
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED this list of conditions and the following disclaimer in the documentation
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE and/or other materials provided with the distribution.
DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * Neither the name of the copyright holder nor the names of its
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; contributors may be used to endorse or promote products derived from
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND this software without specific prior written permission.
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

155
pkgs/misc/documentation-highlighter/README.md
View file

@ -1,132 +1,30 @@
This file was generated with pkgs/misc/documentation-highlighter/update.sh This file was generated with pkgs/misc/documentation-highlighter/update.sh
# Highlight.js # Highlight.js CDN Assets
[![Build Status](https://travis-ci.org/isagalaev/highlight.js.svg?branch=master)](https://travis-ci.org/isagalaev/highlight.js) [![install size](https://packagephobia.now.sh/badge?p=highlight.js)](https://packagephobia.now.sh/result?p=highlight.js)
**This package contains only the CDN build assets of highlight.js.**
This may be what you want if you'd like to install the pre-built distributable highlight.js client-side assets via NPM. If you're wanting to use highlight.js mainly on the server-side you likely want the [highlight.js][1] package instead.
To access these files via CDN:<br>
https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/
**If you just want a single .js file with the common languages built-in:
<https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/highlight.min.js>**
---
## Highlight.js
Highlight.js is a syntax highlighter written in JavaScript. It works in Highlight.js is a syntax highlighter written in JavaScript. It works in
the browser as well as on the server. It works with pretty much any the browser as well as on the server. It works with pretty much any
markup, doesn’t depend on any framework and has automatic language markup, doesn’t depend on any framework, and has automatic language
detection. detection.
## Getting Started If you'd like to read the full README:<br>
<https://github.com/highlightjs/highlight.js/blob/main/README.md>
The bare minimum for using highlight.js on a web page is linking to the
library along with one of the styles and calling
[`initHighlightingOnLoad`][1]:
```html
<link rel="stylesheet" href="/path/to/styles/default.css">
<script src="/path/to/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
```
This will find and highlight code inside of `<pre><code>` 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
<pre><code class="html">...</code></pre>
```
The list of supported language classes is available in the [class
reference][2]. Classes can also be prefixed with either `language-` or
`lang-`.
To disable highlighting altogether use the `nohighlight` class:
```html
<pre><code class="nohighlight">...</code></pre>
```
## Custom Initialization
When you need a bit more control over the initialization of
highlight.js, you can use the [`highlightBlock`][3] and [`configure`][4]
functions. This allows you to control *what* to highlight and *when*.
Here’s an equivalent way to calling [`initHighlightingOnLoad`][1] using
jQuery:
```javascript
$(document).ready(function() {
$('pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
});
```
You can use any tags instead of `<pre><code>` to mark up your code. If
you don't use a container that preserve line breaks you will need to
configure highlight.js to use the `<br>` tag:
```javascript
hljs.configure({useBR: true});
$('div.code').each(function(i, block) {
hljs.highlightBlock(block);
});
```
For other options refer to the documentation for [`configure`][4].
## Web Workers
You can run highlighting inside a web worker to avoid freezing the browser
window while dealing with very big chunks of code.
In your main script:
```javascript
addEventListener('load', function() {
var code = document.querySelector('#code');
var worker = new Worker('worker.js');
worker.onmessage = function(event) { code.innerHTML = event.data; }
worker.postMessage(code.textContent);
})
```
In worker.js:
```javascript
onmessage = function(event) {
importScripts('<path>/highlight.pack.js');
var result = self.hljs.highlightAuto(event.data);
postMessage(result.value);
}
```
## Getting the Library
You can get highlight.js as a hosted, or custom-build, browser script or
as a server module. Right out of the box the browser script supports
both AMD and CommonJS, so if you wish you can use RequireJS or
Browserify without having to build from source. The server module also
works perfectly fine with Browserify, but there is the option to use a
build specific to browsers rather than something meant for a server.
Head over to the [download page][5] for all the options.
**Don't link to GitHub directly.** The library is not supposed to work straight
from the source, it requires building. If none of the pre-packaged options
work for you refer to the [building documentation][6].
**The CDN-hosted package doesn't have all the languages.** Otherwise it'd be
too big. If you don't see the language you need in the ["Common" section][5],
it can be added manually:
```html
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.4.0/languages/go.min.js"></script>
```
**On Almond.** You need to use the optimizer to give the module a name. For
example:
```
r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
```
## License ## License
@ -137,16 +35,13 @@ for details.
The official site for the library is at <https://highlightjs.org/>. The official site for the library is at <https://highlightjs.org/>.
The Github project may be found at: <https://github.com/highlightjs/highlight.js>
Further in-depth documentation for the API and other topics is at Further in-depth documentation for the API and other topics is at
<http://highlightjs.readthedocs.io/>. <http://highlightjs.readthedocs.io/>.
Authors and contributors are listed in the [AUTHORS.en.txt][8] file. A list of the Core Team and contributors can be found in the [CONTRIBUTORS.md][8] file.
[1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload [1]: https://www.npmjs.com/package/highlight.js
[2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html [7]: https://github.com/highlightjs/highlight.js/blob/main/LICENSE
[3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block [8]: https://github.com/highlightjs/highlight.js/blob/main/CONTRIBUTORS.md
[4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
[5]: https://highlightjs.org/download/
[6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt

347
pkgs/misc/documentation-highlighter/highlight.pack.js
View file

File diff suppressed because one or more lines are too long

11
pkgs/misc/documentation-highlighter/loader.js
View file

@ -1,7 +1,6 @@
/* This file is NOT part of highlight.js */ /* This file is NOT part of highlight.js */
document.onreadystatechange = function () { document.addEventListener('DOMContentLoaded', (event) => {
var listings = document.querySelectorAll('.programlisting, .screen'); document.querySelectorAll('.programlisting, .screen').forEach((element) => {
for (i = 0; i < listings.length; ++i) { hljs.highlightElement(element);
hljs.highlightBlock(listings[i]); });
} });
}

33
pkgs/misc/documentation-highlighter/mono-blue.css
View file

@ -1,17 +1,18 @@
pre code.hljs {
display: block;
overflow-x: auto;
padding: 1em
}
code.hljs {
padding: 3px 5px
}
/* /*
Five-color theme from a single blue hue. Five-color theme from a single blue hue.
*/ */
.hljs { .hljs {
display: block;
overflow-x: auto;
padding: 0.5em;
background: #eaeef3; background: #eaeef3;
color: #00193a
} }
.hljs {
color: #00193a;
}
.hljs-keyword, .hljs-keyword,
.hljs-selector-tag, .hljs-selector-tag,
.hljs-title, .hljs-title,
@ -19,13 +20,11 @@
.hljs-doctag, .hljs-doctag,
.hljs-name, .hljs-name,
.hljs-strong { .hljs-strong {
font-weight: bold; font-weight: bold
} }
.hljs-comment { .hljs-comment {
color: #738191; color: #738191
} }
.hljs-string, .hljs-string,
.hljs-title, .hljs-title,
.hljs-section, .hljs-section,
@ -38,9 +37,8 @@
.hljs-name, .hljs-name,
.hljs-selector-id, .hljs-selector-id,
.hljs-selector-class { .hljs-selector-class {
color: #0048ab; color: #0048ab
} }
.hljs-meta, .hljs-meta,
.hljs-subst, .hljs-subst,
.hljs-symbol, .hljs-symbol,
@ -51,9 +49,8 @@
.hljs-template-variable, .hljs-template-variable,
.hljs-link, .hljs-link,
.hljs-bullet { .hljs-bullet {
color: #4c81c9; color: #4c81c9
} }
.hljs-emphasis { .hljs-emphasis {
font-style: italic; font-style: italic
} }

18
pkgs/misc/documentation-highlighter/update.sh
View file

@ -21,19 +21,21 @@ trap finish EXIT
mkdir $scratch/src mkdir $scratch/src
cd $scratch/src cd $scratch/src
token=$(curl https://highlightjs.org/download/ -c "$scratch/jar" \ curl \
| grep csrf \ -X POST \
| cut -d"'" -f6) -H 'Content-Type: application/json' \
--data-raw '{
"api": 2,
"languages": ["bash", "nix", "shell"]
}' \
https://highlightjs.org/api/download > $scratch/out.zip
curl --header "Referer: https://highlightjs.org/download/"\
-b "$scratch/jar" \
--data "csrfmiddlewaretoken=$token&nix.js=on&bash.js=on" \
https://highlightjs.org/download/ > $scratch/out.zip
unzip "$scratch/out.zip" unzip "$scratch/out.zip"
out="$root/" out="$root/"
mkdir -p "$out" mkdir -p "$out"
cp ./{highlight.pack.js,LICENSE,styles/mono-blue.css} "$out" cp ./highlight.min.js "$out/highlight.pack.js"
cp ./{LICENSE,styles/mono-blue.css} "$out"
( (
echo "This file was generated with pkgs/misc/documentation-highlighter/update.sh" echo "This file was generated with pkgs/misc/documentation-highlighter/update.sh"