Skip to content

Commit

Permalink
chore: update highlight.js to v11.9.0 and optimize syntax highlighting (
Browse files Browse the repository at this point in the history
#400)

- upgrade highlight.js from 9.18.3 to 11.9.0
- simplify highlight.bundle.js by using common bundle and automatic language detection
- update build configuration for css processing
- update package.json and package-lock.json dependencies
- fix javascript lint errors

fixes #397
  • Loading branch information
julioest authored Jan 31, 2025
1 parent d91a92e commit 3cc8b82
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 52 deletions.
15 changes: 10 additions & 5 deletions antora-ui/gulp.d/tasks/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,16 @@ function getAllTasks (opts, sourcemaps, postcssPlugins, preview, src) {
// Task for processing CSS files
// NOTE use the next line to bundle a JavaScript library that cannot be browserified, like jQuery
//vfs.src(require.resolve('<package-name-or-require-path>'), opts).pipe(concat('js/vendor/<library-name>.js')),
vfs.src('css/boostlook.css', opts)
.pipe(postcss([autoprefixer, preview ? () => {} : cssnano({
preset: 'default',
}),
])),
vfs.src('css/boostlook.css', opts).pipe(
postcss([
autoprefixer,
preview
? () => {}
: cssnano({
preset: 'default',
}),
])
),
vfs
.src(['css/site.css', 'css/vendor/*.css'], { ...opts, sourcemaps })
.pipe(postcss((file) => ({ plugins: postcssPlugins, options: { file } }))),
Expand Down
2 changes: 1 addition & 1 deletion antora-ui/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
'use strict'

// This placeholder script allows this package to be discovered using require.resolve.
// It may be used in the future to export information about the files in this UI.
12 changes: 6 additions & 6 deletions antora-ui/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion antora-ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"gulp-uglify": "~3.0",
"gulp-vinyl-zip": "~2.2",
"handlebars": "~4.7",
"highlight.js": "9.18.3",
"highlight.js": "^11.9.0",
"js-yaml": "~3.13",
"merge-stream": "~2.0",
"postcss-calc": "~7.0",
Expand Down
45 changes: 7 additions & 38 deletions antora-ui/src/js/vendor/highlight.bundle.js
Original file line number Diff line number Diff line change
@@ -1,43 +1,12 @@
;(function () {
'use strict'

var hljs = require('highlight.js/lib/highlight')
hljs.registerLanguage('asciidoc', require('highlight.js/lib/languages/asciidoc'))
hljs.registerLanguage('bash', require('highlight.js/lib/languages/bash'))
hljs.registerLanguage('clojure', require('highlight.js/lib/languages/clojure'))
hljs.registerLanguage('cpp', require('highlight.js/lib/languages/cpp'))
var hljs = require('highlight.js/lib/common')

// Only register languages not included in common bundle
hljs.registerLanguage('cmake', require('highlight.js/lib/languages/cmake'))
hljs.registerLanguage('cs', require('highlight.js/lib/languages/cs'))
hljs.registerLanguage('css', require('highlight.js/lib/languages/css'))
hljs.registerLanguage('diff', require('highlight.js/lib/languages/diff'))
hljs.registerLanguage('dockerfile', require('highlight.js/lib/languages/dockerfile'))
hljs.registerLanguage('elixir', require('highlight.js/lib/languages/elixir'))
hljs.registerLanguage('go', require('highlight.js/lib/languages/go'))
hljs.registerLanguage('groovy', require('highlight.js/lib/languages/groovy'))
hljs.registerLanguage('haskell', require('highlight.js/lib/languages/haskell'))
hljs.registerLanguage('java', require('highlight.js/lib/languages/java'))
hljs.registerLanguage('javascript', require('highlight.js/lib/languages/javascript'))
hljs.registerLanguage('json', require('highlight.js/lib/languages/json'))
hljs.registerLanguage('kotlin', require('highlight.js/lib/languages/kotlin'))
hljs.registerLanguage('lua', require('highlight.js/lib/languages/lua'))
hljs.registerLanguage('markdown', require('highlight.js/lib/languages/markdown'))
hljs.registerLanguage('nix', require('highlight.js/lib/languages/nix'))
hljs.registerLanguage('none', require('highlight.js/lib/languages/plaintext'))
hljs.registerLanguage('objectivec', require('highlight.js/lib/languages/objectivec'))
hljs.registerLanguage('perl', require('highlight.js/lib/languages/perl'))
hljs.registerLanguage('php', require('highlight.js/lib/languages/php'))
hljs.registerLanguage('properties', require('highlight.js/lib/languages/properties'))
hljs.registerLanguage('puppet', require('highlight.js/lib/languages/puppet'))
hljs.registerLanguage('python', require('highlight.js/lib/languages/python'))
hljs.registerLanguage('ruby', require('highlight.js/lib/languages/ruby'))
hljs.registerLanguage('rust', require('highlight.js/lib/languages/rust'))
hljs.registerLanguage('scala', require('highlight.js/lib/languages/scala'))
hljs.registerLanguage('shell', require('highlight.js/lib/languages/shell'))
hljs.registerLanguage('sql', require('highlight.js/lib/languages/sql'))
hljs.registerLanguage('swift', require('highlight.js/lib/languages/swift'))
hljs.registerLanguage('xml', require('highlight.js/lib/languages/xml'))
hljs.registerLanguage('yaml', require('highlight.js/lib/languages/yaml'))
;[].slice.call(document.querySelectorAll('pre code.hljs[data-lang]')).forEach(function (node) {
hljs.highlightBlock(node)
})

hljs.highlightAll()

window.hljs = hljs
})()
2 changes: 1 addition & 1 deletion antora-ui/tailwind.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ module.exports = {
theme: {
extend: {},
},
plugins: []
plugins: [],
}

0 comments on commit 3cc8b82

Please sign in to comment.