Skip to content

Commit 45fe0b6

Browse files
committed
fix(highlighting): drop prism
unify on highlight.js for docs, fundocs, and inline md
1 parent 7dd4494 commit 45fe0b6

File tree

8 files changed

+29
-225
lines changed

8 files changed

+29
-225
lines changed

gulpfile.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ const paths = {
3131
"src/main/xar-resources/resources/scripts/*",
3232
"node_modules/bootstrap/dist/js/bootstrap.min.*",
3333
"node_modules/jquery/dist/jquery.min.*",
34-
"node_modules/prismjs/prism.js",
35-
"node_modules/prismjs/components/prism-xquery.min.js",
36-
"node_modules/prismjs/components/prism-java.min.js",
34+
"node_modules/@highlightjs/cdn-assets/highlight.min.js",
35+
"node_modules/@highlightjs/cdn-assets/languages/xquery.min.js",
3736
"node_modules/zero-md/dist/index.min.js"
3837
],
3938
styles: [
4039
"src/main/xar-resources/resources/css/*",
4140
"node_modules/bootstrap/dist/css/bootstrap.min.*",
42-
// 'node_modules/prismjs/themes/*.css'
41+
"node_modules/@highlightjs/cdn-assets/styles/atom-one-dark.min.css"
4342
],
4443
fonts: ["node_modules/bootstrap/dist/fonts/*"],
4544
},

package-lock.json

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
},
2626
"homepage": "https://github.com/eXist-db/function-documentation#readme",
2727
"dependencies": {
28+
"@highlightjs/cdn-assets": "^11.11.1",
2829
"bootstrap": "^3.4.1",
2930
"jquery": "^1.12.4",
30-
"prismjs": "^1.23.0",
3131
"zero-md": "^3.1.6"
3232
},
3333
"devDependencies": {

src/main/xar-resources/modules/app.xql

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,8 @@ declare %private
279279
function app:include-markdown ($path as xs:string) as element(zero-md) {
280280
<zero-md src="{ $path }">
281281
<template>
282-
<link rel="stylesheet" href="resources/css/exist.css" />
282+
<link rel="stylesheet" type="text/css" href="resources/css/exist.css" />
283+
<link rel="stylesheet" type="text/css" href="resources/css/atom-one-dark.min.css" />
283284
</template>
284285
</zero-md>
285286
};

src/main/xar-resources/resources/css/prism-fundocs.css

Lines changed: 0 additions & 199 deletions
This file was deleted.

src/main/xar-resources/resources/scripts/query.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ $(document).on("ready", function() {
1616
success: function (data) {
1717
$("#results").fadeOut(100, function() {
1818
$(this).html(data);
19-
$(this).fadeIn(100, function() {
20-
Prism.highlightAll()
21-
});
19+
$(this).fadeIn(100);
2220
timeout = null;
2321
});
2422
}

src/main/xar-resources/templates/page.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="shortcut icon" href="resources/images/exist_icon_16x16.ico"/>
77

88
<link rel="stylesheet" type="text/css" href="resources/css/bootstrap.min.css"/>
9-
<link rel="stylesheet" type="text/css" href="resources/css/prism-fundocs.css"/>
9+
<link rel="stylesheet" type="text/css" href="resources/css/atom-one-dark.min.css"/>
1010
<link rel="stylesheet" type="text/css" href="resources/css/exist.css"/>
1111
<link rel="stylesheet" type="text/css" href="resources/css/fundocs.css"/>
1212
<script type="module" src="resources/scripts/index.min.js?register"/>
@@ -211,11 +211,11 @@ <h3>Login</h3>
211211
</div>
212212
</div>
213213
</div>
214-
<script type="text/javascript" src="resources/scripts/jquery.min.js"></script>
215-
<script type="text/javascript" src="resources/scripts/bootstrap.min.js"></script>
216-
<script type="text/javascript" src="resources/scripts/prism.js"></script>
217-
<script type="text/javascript" src="resources/scripts/prism-java.min.js"></script>
218-
<script type="text/javascript" src="resources/scripts/prism-xquery.min.js"></script>
219-
<script type="text/javascript" src="resources/scripts/query.js"></script>
214+
<script type="text/javascript" src="resources/scripts/jquery.min.js"/>
215+
<script type="text/javascript" src="resources/scripts/bootstrap.min.js"/>
216+
<script type="text/javascript" src="resources/scripts/highlight.min.js"/>
217+
<script type="text/javascript" src="resources/scripts/xquery.min.js" />
218+
<script type="text/javascript" src="resources/scripts/query.js"/>
219+
<script type="text/javascript">hljs.highlightAll();</script>
220220
</body>
221221
</html>

src/test/cypress/integration/fundoc_spec.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,20 @@ context('Function Documentation', () => {
1414
})
1515

1616
describe('simple search', () => {
17-
it('should find article with extended markdown contents', () => {
17+
it('should find article with extended markdown contents and code highlighting', () => {
1818
cy.get('#query-field')
1919
.type('file:sync')
2020
cy.get('.function-head > h4')
2121
.should('exist')
2222
.click()
23+
// code is highlighted
24+
cy.get('.language-xquery')
25+
.should('exist')
26+
// button is visible
2327
cy.get('.extended-docs')
2428
.should('exist')
2529
.click()
30+
// displays MD
2631
cy.get('zero-md')
2732
.should('exist')
2833
})

0 commit comments

Comments
 (0)