Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Expose cdn settings as params #1204

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions layouts/partials/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
{{ template "_internal/twitter_cards.html" . -}}
{{ partialCached "head-css.html" . "asdf" -}}
<script
src="https://code.jquery.com/jquery-3.6.0.min.js"
integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK"
src="{{ .Site.Params.cdn.jquery.url | default `https://code.jquery.com/jquery-3.6.0.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.jquery.checksum | default `sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK` }}"
crossorigin="anonymous"></script>
{{ if .Site.Params.offlineSearch -}}
<script defer
src="https://unpkg.com/[email protected]/lunr.min.js"
integrity="sha384-203J0SNzyqHby3iU6hzvzltrWi/M41wOP5Gu+BiJMz5nwKykbkUx8Kp7iti0Lpli"
src="{{ .Site.Params.cdn.lunrjs.url | default `https://unpkg.com/[email protected]/lunr.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.lunrjs.checksum | default `sha384-203J0SNzyqHby3iU6hzvzltrWi/M41wOP5Gu+BiJMz5nwKykbkUx8Kp7iti0Lpli` }}"
crossorigin="anonymous"></script>
{{ end -}}

Expand Down
42 changes: 29 additions & 13 deletions layouts/partials/scripts.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{{ if .Site.Params.mermaid.enable -}}
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js" integrity="sha512-E/owfVh8/U1xwhvIT4HSI064DRc1Eo/xf7AYax84rt9gVqA8tc/JNH/lvTl1tuw9PUHQIMGUtObkjYkgRjFqAA==" crossorigin="anonymous"></script>
<script
src="{{ .Site.Params.cdn.mermaidjs.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.mermaidjs.checksum | default `sha512-E/owfVh8/U1xwhvIT4HSI064DRc1Eo/xf7AYax84rt9gVqA8tc/JNH/lvTl1tuw9PUHQIMGUtObkjYkgRjFqAA==1` }}"
crossorigin="anonymous"></script>
{{ end -}}

{{ if .Site.Params.markmap.enable -}}
Expand All @@ -20,7 +23,10 @@
},
};
</script>
<script src="https://cdn.jsdelivr.net/npm/markmap-autoloader"></script>
<script
src="{{ .Site.Params.cdn.markmap.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/index.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.markmap.checksum | default `sha256-Yllbe19RIsDlnBmUHGLiUUrFdvAv5yQcq1oVsEWC1Zs=` }}"
crossorigin="anonymous"></script>
{{ end -}}

{{ if .Site.Params.plantuml.enable -}}
Expand All @@ -29,26 +35,36 @@

{{ if .Site.Params.katex.enable -}}
<!-- load stylesheet and scripts for KaTeX support -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css"
integrity="sha512-vJqxkZ+Sugf/6WRlpcxN01qVfX/29hF6qc33eHF1va3NgoV+U+wCi+uTAsQ10sDoGyBxHLdaHvGwDlV3yVYboA==" crossorigin="anonymous">
<link
rel="stylesheet"
href="{{ .Site.Params.cdn.katexcss.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css` | safeURL }}"
integrity="{{ .Site.Params.cdn.katexcss.checksum | default `sha512-vJqxkZ+Sugf/6WRlpcxN01qVfX/29hF6qc33eHF1va3NgoV+U+wCi+uTAsQ10sDoGyBxHLdaHvGwDlV3yVYboA==` }}"
crossorigin="anonymous">
<!-- The loading of KaTeX is deferred to speed up page rendering -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js"
integrity="sha512-5ufNcHqOYgilGEHPfuRIQ5B/vDS1M8+UC+DESZ5CwVgGTg+b2Ol/15rYL/GiCWJ/Sx8oVo0FPFok1dPk8U9INQ=="
crossorigin="anonymous"></script>
<script
defer
src="{{ .Site.Params.cdn.katexjs.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.katexjs.checksum | default `sha512-5ufNcHqOYgilGEHPfuRIQ5B/vDS1M8+UC+DESZ5CwVgGTg+b2Ol/15rYL/GiCWJ/Sx8oVo0FPFok1dPk8U9INQ==` }}"
crossorigin="anonymous"></script>
<!-- check whether support of mhchem is enabled in config.toml -->
{{ if .Site.Params.katex.mhchem.enable -}}
<!-- To add support for displaying chemical equations and physical units, load the mhchem extension: -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/mhchem.min.js"
integrity="sha512-HWb6LyQhO6UkmYLjdSblpgiOvvbdkoMRjln0POPhOVbZu3l4QdqwZnMJ/cuwKScU5pWARejB495TAAAz0WNsXQ=="
crossorigin="anonymous"></script>
<script
defer
src="{{ .Site.Params.cdn.katex_mhchem.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/mhchem.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.katex_mhchem.checksum | default `sha512-HWb6LyQhO6UkmYLjdSblpgiOvvbdkoMRjln0POPhOVbZu3l4QdqwZnMJ/cuwKScU5pWARejB495TAAAz0WNsXQ==` }}"
crossorigin="anonymous"></script>
{{ end -}}
<!-- To automatically render math in text elements, include the auto-render extension: -->
<script defer src='https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js'
integrity='sha512-ZA/RPrAo88DlwRnnoNVqKINnQNcWERzRK03PDaA4GIJiVZvGFIWQbdWCsUebMZfkWohnfngsDjXzU6PokO4jGw==' crossorigin='anonymous'
<script
defer
src="{{ .Site.Params.cdn.katex_auto_render.url | default `https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js` | safeURL }}"
integrity="{{ .Site.Params.cdn.katex_auto_render.checksum | default `sha512-ZA/RPrAo88DlwRnnoNVqKINnQNcWERzRK03PDaA4GIJiVZvGFIWQbdWCsUebMZfkWohnfngsDjXzU6PokO4jGw==` }}"
crossorigin="anonymous"
{{ printf "onload='renderMathInElement(%s, %s);'" (( .Site.Params.katex.html_dom_element | default "document.body" ) | safeJS ) ( printf "%s" ( $.Site.Params.katex.options | jsonify )) | safeHTMLAttr }}></script>
{{ end -}}

{{ $jsPopper := resources.GetRemote "https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" -}}
{{ $jsPopper := resources.GetRemote (.Site.Params.cdn.popperjs.url | default "https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" | safeURL) -}}
{{ $jsBs := resources.Get "vendor/bootstrap/dist/js/bootstrap.js" -}}
{{ $jsBase := resources.Get "js/base.js" -}}
{{ $jsAnchor := resources.Get "js/anchor.js" -}}
Expand Down
18 changes: 11 additions & 7 deletions layouts/shortcodes/redoc.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
}
#redoc h2 { margin-top: 0px;}
</style>

<!-- Back to top button start -->
<style>
#myBtn {
Expand All @@ -40,7 +40,7 @@
padding: 15px;
border-radius: 4px;
}

#myBtn:hover {
background-color: #555;
}
Expand All @@ -49,18 +49,18 @@
<script>
//Get the button
var mybutton = document.getElementById("myBtn");

// When the user scrolls down 20px from the top of the document, show the button
window.onscroll = function() {scrollFunction()};

function scrollFunction() {
if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
mybutton.style.display = "block";
} else {
mybutton.style.display = "none";
}
}

// When the user clicks on the button, scroll to the top of the document
function topFunction() {
document.body.scrollTop = 0;
Expand All @@ -83,9 +83,13 @@
Redoc element with link to your OpenAPI definition
-->
<div id="redoc-container">
<redoc spec-url='{{ $url }}' hide-hostname="true" suppress-warnings="true" lazy-rendering native-scrollbars scroll-y-offset=".js-navbar-scroll" {{ $otheroptions }}></redoc>
<redoc spec-url='{{ $url }}" hide-hostname="true" suppress-warnings="true" lazy-rendering native-scrollbars scroll-y-offset=".js-navbar-scroll" {{ $otheroptions }}></redoc>
</div>
<!--
Link to Redoc JavaScript on CDN for rendering standalone element
-->
<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"></script>
<script
src="{{ .Site.Params.cdn.redocjs.url | default `https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js` }}"
integrity="{{ .Site.Params.cdn.redocjs.checksum | default `sha256-4byV6ohraqjCjVpsPoK6wRuZks6zGUq4cj8+0X89APs=` }}"
crossorigin="anonymous"></script>

32 changes: 32 additions & 0 deletions userguide/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,38 @@ params:
markmap:
enable: true

cdn:
jquery:
url: https://code.jquery.com/jquery-3.6.0.min.js
checksum: sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK
lunrjs:
url: https://unpkg.com/[email protected]/lunr.min.js
checksum: sha384-203J0SNzyqHby3iU6hzvzltrWi/M41wOP5Gu+BiJMz5nwKykbkUx8Kp7iti0Lpli
mermaidjs:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js
checksum: sha512-E/owfVh8/U1xwhvIT4HSI064DRc1Eo/xf7AYax84rt9gVqA8tc/JNH/lvTl1tuw9PUHQIMGUtObkjYkgRjFqAA==
markmap:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/index.min.js
checksum: sha256-Yllbe19RIsDlnBmUHGLiUUrFdvAv5yQcq1oVsEWC1Zs=
katexjs:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js
checksum: sha512-5ufNcHqOYgilGEHPfuRIQ5B/vDS1M8+UC+DESZ5CwVgGTg+b2Ol/15rYL/GiCWJ/Sx8oVo0FPFok1dPk8U9INQ==
katexcss:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css
checksum: sha512-vJqxkZ+Sugf/6WRlpcxN01qVfX/29hF6qc33eHF1va3NgoV+U+wCi+uTAsQ10sDoGyBxHLdaHvGwDlV3yVYboA==
katex_mhchem:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/mhchem.min.js
checksum: sha512-HWb6LyQhO6UkmYLjdSblpgiOvvbdkoMRjln0POPhOVbZu3l4QdqwZnMJ/cuwKScU5pWARejB495TAAAz0WNsXQ==
katex_auto_render:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js
checksum: sha512-ZA/RPrAo88DlwRnnoNVqKINnQNcWERzRK03PDaA4GIJiVZvGFIWQbdWCsUebMZfkWohnfngsDjXzU6PokO4jGw==
popperjs:
url: https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js
checksum:
redocjs:
url: https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js
checksum: sha256-4byV6ohraqjCjVpsPoK6wRuZks6zGUq4cj8+0X89APs=

taxonomies:
tag: tags
category: categories
Expand Down