Skip to content

Commit

Permalink
Merge pull request #1590 from JuliaDocs/mp/v0.27.0
Browse files Browse the repository at this point in the history
Set version to 0.27.0
  • Loading branch information
mortenpi authored Jun 10, 2021
2 parents 9f54fe2 + 3b802e9 commit cf9e4a2
Show file tree
Hide file tree
Showing 9 changed files with 131 additions and 58 deletions.
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,21 @@

* ![Enhancement][badge-enhancement] The JS dependencies have been updated to their respective latest versions.

- highlight.js has been updated to `v10.5.0`, which also brings various updates to the highlighting of Julia code. Due to the changes in highlight.js, code highlighting will not work on IE11. ([#1503][github-1503], [#1551][github-1551])
- highlight.js has been updated to `v11.0.1` (major version bump), which also brings various updates to the highlighting of Julia code. Due to the changes in highlight.js, code highlighting will not work on IE11. ([#1503][github-1503], [#1551][github-1551], [#1590][github-1590])

- Headroom.js has been updated to `v0.12.0` (major version bump). ([#1590][github-1590])

- KaTeX been updated to `v0.13.11` (major version bump). ([#1590][github-1590])

- MathJax versions have been updated to `v2.7.7` (patch version bump) and `v3.1.4` (minor version bump), for MathJax 2 and 3, respectively. ([#1590][github-1590])

- jQuery been updated to `v3.6.0` (minor version bump). ([#1590][github-1590])

- Font Awesome has been updated to `v5.15.3` (patch version bump). ([#1590][github-1590])

- lunr.js has been updated to `v2.3.9` (patch version bump). ([#1590][github-1590])

- lodash.js has been updated to `v4.17.21` (patch version bump). ([#1590][github-1590])

* ![Enhancement][badge-enhancement] `deploydocs` now throws an error if something goes wrong with the Git invocations used to deploy to `gh-pages`. ([#1529][github-1529])

Expand Down Expand Up @@ -793,6 +807,7 @@
[github-1559]: https://github.com/JuliaDocs/Documenter.jl/pull/1559
[github-1567]: https://github.com/JuliaDocs/Documenter.jl/pull/1567
[github-1577]: https://github.com/JuliaDocs/Documenter.jl/pull/1577
[github-1590]: https://github.com/JuliaDocs/Documenter.jl/pull/1590

[julia-38079]: https://github.com/JuliaLang/julia/issues/38079
[julia-39841]: https://github.com/JuliaLang/julia/pull/39841
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "Documenter"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.26.1"
version = "0.27.0"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
25 changes: 12 additions & 13 deletions assets/html/scss/highlightjs/a11y-dark.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
/* a11y-dark theme */
/* Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css */
/* @author: ericwbailey */
/*!
Theme: a11y-dark
Author: @ericwbailey
Maintainer: @ericwbailey
Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css
*/

.hljs {
background: #2b2b2b;
color: #f8f8f2;
}

/* Comment */
.hljs-comment,
Expand All @@ -23,7 +32,6 @@
/* Orange */
.hljs-number,
.hljs-built_in,
.hljs-builtin-name,
.hljs-literal,
.hljs-type,
.hljs-params,
Expand Down Expand Up @@ -57,14 +65,6 @@
color: #dcc6e0;
}

.hljs {
display: block;
overflow-x: auto;
background: #2b2b2b;
color: #f8f8f2;
padding: 0.5em;
}

.hljs-emphasis {
font-style: italic;
}
Expand All @@ -77,7 +77,6 @@
.hljs-addition,
.hljs-attribute,
.hljs-built_in,
.hljs-builtin-name,
.hljs-bullet,
.hljs-comment,
.hljs-link,
Expand Down
56 changes: 45 additions & 11 deletions assets/html/scss/highlightjs/default.css
Original file line number Diff line number Diff line change
@@ -1,32 +1,66 @@
/*
/*!
Theme: Default
Description: Original highlight.js style
Author: (c) Ivan Sagalaev <[email protected]>
Maintainer: @highlightjs/core-team
Website: https://highlightjs.org/
License: see project LICENSE
Touched: 2021
*/

Original highlight.js style (c) Ivan Sagalaev <[email protected]>
/*
This is left on purpose making default.css the single file that can be lifted
as-is from the repository directly without the need for a build step
Typically this "required" baseline CSS is added by `makestuff.js` during build.
*/

.hljs {
pre code.hljs {
display: block;
overflow-x: auto;
padding: 0.5em;
background: #F0F0F0;
padding: 1em;
}

code.hljs {
padding: 3px 5px;
}
/* end baseline CSS */

.hljs {
background: #F0F0F0;
color: #444;
}

/* Base color: saturation 0; */

.hljs,
.hljs-subst {
color: #444;
/* default */
}

/* purposely ignored */
.hljs-formula,
.hljs-attr,
.hljs-property,
.hljs-params {}

.hljs-comment {
color: #888888;
}
.hljs-tag,
.hljs-punctuation {
color: #444a;
}

.hljs-tag .hljs-name,
.hljs-tag .hljs-attr {
color: #444;
}


.hljs-keyword,
.hljs-attribute,
.hljs-selector-tag,
.hljs-meta-keyword,
.hljs-meta .hljs-keyword,

.hljs-doctag,
.hljs-name {
font-weight: bold;
Expand Down Expand Up @@ -58,11 +92,11 @@ Original highlight.js style (c) Ivan Sagalaev <[email protected]>
.hljs-template-variable,
.hljs-link,
.hljs-selector-attr,
.hljs-operator,
.hljs-selector-pseudo {
color: #BC6060;
}


/* Language color: hue: 90; */

.hljs-literal {
Expand All @@ -83,7 +117,7 @@ Original highlight.js style (c) Ivan Sagalaev <[email protected]>
color: #1f7199;
}

.hljs-meta-string {
.hljs-meta .hljs-string {
color: #4d99bf;
}

Expand Down
21 changes: 10 additions & 11 deletions assets/html/themes/documenter-dark.css

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

44 changes: 35 additions & 9 deletions assets/html/themes/documenter-light.css

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

2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"

[compat]
DocumenterTools = "=0.1.11"
DocumenterTools = "=0.1.12"
20 changes: 10 additions & 10 deletions src/Writers/HTMLWriter.jl
Original file line number Diff line number Diff line change
Expand Up @@ -446,20 +446,20 @@ module RD

const requirejs_cdn = "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"
const google_fonts = "https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"
const fontawesome_version = "5.15.0"
const fontawesome_version = "5.15.3"
const fontawesome_css = [
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/$(fontawesome_version)/css/fontawesome.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/$(fontawesome_version)/css/solid.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/$(fontawesome_version)/css/brands.min.css",
]

const jquery = RemoteLibrary("jquery", "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js")
const jquery = RemoteLibrary("jquery", "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js")
const jqueryui = RemoteLibrary("jqueryui", "https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.min.js")
const lunr = RemoteLibrary("lunr", "https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.6/lunr.min.js")
const lodash = RemoteLibrary("lodash", "https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.15/lodash.min.js")
const lunr = RemoteLibrary("lunr", "https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.9/lunr.min.js")
const lodash = RemoteLibrary("lodash", "https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.21/lodash.min.js")

# headroom
const headroom_version = "0.10.3"
const headroom_version = "0.12.0"
const headroom = RemoteLibrary("headroom", "https://cdnjs.cloudflare.com/ajax/libs/headroom/$(headroom_version)/headroom.min.js")
const headroom_jquery = RemoteLibrary(
"headroom-jquery",
Expand All @@ -473,7 +473,7 @@ module RD
# NOTE: the CSS themes for hightlightjs are compiled into the Documenter CSS
# When updating this dependency, it is also necessary to update the the CSS
# files the CSS files in assets/html/scss/highlightjs
hljs_version = "10.5.0"
hljs_version = "11.0.1"
push!(r, RemoteLibrary(
"highlight",
"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/$(hljs_version)/highlight.min.js"
Expand All @@ -492,14 +492,14 @@ module RD
["\$"],
raw"""
$(document).ready(function() {
hljs.initHighlighting();
hljs.highlightAll();
})
"""
))
end

# MathJax & KaTeX
const katex_version = "0.11.1"
const katex_version = "0.13.11"
const katex_css = "https://cdnjs.cloudflare.com/ajax/libs/KaTeX/$(katex_version)/katex.min.css"
function mathengine!(r::RequireJS, engine::KaTeX)
push!(r, RemoteLibrary(
Expand All @@ -525,7 +525,7 @@ module RD
))
end
function mathengine!(r::RequireJS, engine::MathJax2)
url = isempty(engine.url) ? "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-AMS_HTML" : engine.url
url = isempty(engine.url) ? "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-AMS_HTML" : engine.url
push!(r, RemoteLibrary(
"mathjax",
url,
Expand All @@ -538,7 +538,7 @@ module RD
))
end
function mathengine!(r::RequireJS, engine::MathJax3)
url = isempty(engine.url) ? "https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.0.5/es5/tex-svg.js" : engine.url
url = isempty(engine.url) ? "https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.1.4/es5/tex-svg.js" : engine.url
push!(r, Snippet([], [],
"""
window.MathJax = $(json_jsescape(engine.config, 2));
Expand Down
Loading

2 comments on commit cf9e4a2

@mortenpi
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

A release various enhancements and bugfixes. The changes are documented in the CHANGELOG.md file.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/38612

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.27.0 -m "<description of version>" cf9e4a23193b6500aa1c349cdce19d524f51b5ba
git push origin v0.27.0

Please sign in to comment.