diff --git a/.gitignore b/.gitignore index 06e397ca9..dd5c21564 100644 --- a/.gitignore +++ b/.gitignore @@ -105,3 +105,6 @@ lerna-debug.log # System Files .DS_Store Thumbs.db + +# Not yet ready locations +/integration-tests diff --git a/Jenkinsfile b/Jenkinsfile index 420bb5b47..c970e0d11 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -10,13 +10,12 @@ pipeline { GLOBAL_AGENT_HTTPS_PROXY = "${WKTUI_PROXY}" WKTUI_DEV_PROXY = "${WKTUI_PROXY}" WKTUI_BUILD_EMAIL = sh(returnStdout: true, script: "echo ${env.WKTUI_BUILD_NOTIFY_EMAIL} | sed -e 's/^[[:space:]]*//'") - WKTUI_PROXY_HOSTPORT = sh(returnStdout: true, script: "echo ${env.WKTUI_PROXY} | sed -e 's,http://,,'") WKTUI_PROXY_HOST = "${env.ORACLE_HTTP_PROXY_HOST}" WKTUI_PROXY_PORT = "${env.ORACLE_HTTP_PROXY_PORT}" npm_registry = "${env.ARTIFACTORY_NPM_REPO}" npm_noproxy = "${env.ORACLE_NO_PROXY}" - node_version = "16.13.0" + node_version = "16.15.1" project_name = "$JOB_NAME" version_prefix = sh(returnStdout: true, script: 'cat electron/package.json | grep version | awk \'match($0, /[0-9]+.[0-9]+.[0-9]+/) { print substr( $0, RSTART, RLENGTH )}\'').trim() @@ -110,15 +109,6 @@ pipeline { sh 'cp ${WORKSPACE}/.npmrc ${WORKSPACE}/electron/.npmrc' } } - stage('Linux Update NPM') { - steps { - sh 'cp -f ${WORKSPACE}/.npmrc ${linux_node_dir}/lib/.npmrc' - sh 'cd ${linux_node_dir}/lib; PATH="${linux_node_dir}/bin:$PATH" ${linux_npm_exe} install npm; cd ${WORKSPACE}' - sh 'rm -f ${linux_node_dir}/lib/.npmrc' - sh 'PATH="${linux_node_dir}/bin:$PATH" ${linux_node_exe} --version' - sh 'PATH="${linux_node_dir}/bin:$PATH" ${linux_npm_exe} --version' - } - } stage('Linux Install Project Dependencies') { steps { sh 'cat ${WORKSPACE}/webui/.npmrc' @@ -203,7 +193,7 @@ pipeline { } } stage('MacOS Build') { - agent { label 'macosx'} + agent { label('wls-mini1 || wls-mini2') } environment { mac_node_dir_name = "node-v${node_version}-darwin-x64" mac_node_installer = "node-v${node_version}-darwin-x64.tar.gz" @@ -219,6 +209,7 @@ pipeline { sh 'env|sort' echo "file version = ${version_number}" echo "is_release = ${is_release}" + sh "uname -a" } } stage('MacOS Checkout') { @@ -254,15 +245,6 @@ pipeline { sh 'cp ${WORKSPACE}/.npmrc ${WORKSPACE}/electron/.npmrc' } } - stage('MacOS Update NPM') { - steps { - sh 'cp -f ${WORKSPACE}/.npmrc ${mac_node_dir}/lib/.npmrc' - sh 'cd ${mac_node_dir}/lib; PATH="${mac_node_dir}/bin:$PATH" ${mac_npm_exe} install npm; cd ${WORKSPACE}' - sh 'rm -f ${mac_node_dir}/lib/.npmrc' - sh 'PATH="${mac_node_dir}/bin:$PATH" ${mac_node_exe} --version' - sh 'PATH="${mac_node_dir}/bin:$PATH" ${mac_npm_exe} --version' - } - } stage('MacOS Install Project Dependencies') { steps { sh 'cat ${WORKSPACE}/webui/.npmrc' @@ -298,13 +280,21 @@ pipeline { } stage('MacOS Build Installers') { steps { - sh 'cd ${WORKSPACE}/electron; PATH="${mac_node_dir}/bin:$PATH" HTTPS_PROXY=${WKTUI_PROXY} CSC_IDENTITY_AUTO_DISCOVERY=false ${mac_npm_exe} run build' + sh ''' + cd "${WORKSPACE}/electron" + PATH="${mac_node_dir}/bin:$PATH" HTTPS_PROXY=${WKTUI_PROXY} CSC_IDENTITY_AUTO_DISCOVERY=false ${mac_npm_exe} run build:jet + PATH="${mac_node_dir}/bin:$PATH" HTTPS_PROXY=${WKTUI_PROXY} CSC_IDENTITY_AUTO_DISCOVERY=false ${mac_npm_exe} run install-tools + PATH="${mac_node_dir}/bin:$PATH" HTTPS_PROXY=${WKTUI_PROXY} CSC_IDENTITY_AUTO_DISCOVERY=false ${mac_npm_exe} run build:installer -- --mac --x64 --arm64 + cd "${WORKSPACE}" + ''' archiveArtifacts 'dist/*.dmg' archiveArtifacts 'dist/*.zip' archiveArtifacts "dist/*.blockmap" archiveArtifacts "dist/latest-mac.yml" sh 'ditto -c -k --sequesterRsrc --keepParent "$WORKSPACE/dist/mac/WebLogic Kubernetes Toolkit UI.app" "WebLogic Kubernetes Toolkit UI.app.zip"' archiveArtifacts "WebLogic Kubernetes Toolkit UI.app.zip" + sh 'ditto -c -k --sequesterRsrc --keepParent "$WORKSPACE/dist/mac-arm64/WebLogic Kubernetes Toolkit UI.app" "WebLogic Kubernetes Toolkit UI.arm64.app.zip"' + archiveArtifacts "WebLogic Kubernetes Toolkit UI.arm64.app.zip" } } } @@ -368,13 +358,6 @@ pipeline { bat 'copy /Y "%WORKSPACE%\\.npmrc" "%WORKSPACE%\\electron\\.npmrc"' } } - stage('Windows Update NPM') { - steps { - bat 'copy /Y "%WORKSPACE%\\.npmrc" "%windows_node_dir%\\.npmrc"' - bat 'cd "%windows_node_dir%" & set "PATH=%windows_node_dir%;%PATH%" & "%windows_npm_exe%" install npm@latest & cd "%WORKSPACE%"' - bat 'del /F /Q "%windows_node_dir%\\.npmrc"' - } - } stage('Windows Install Project Dependencies') { steps { bat 'cd "%WORKSPACE%\\electron" & set "PATH=%windows_node_dir%;%PATH%" & set HTTPS_PROXY=%ORACLE_HTTP_PROXY% & "%windows_npm_exe%" install & cd "%WORKSPACE%"' @@ -395,6 +378,9 @@ pipeline { stage('Windows Build Installers') { steps { bat 'cd "%WORKSPACE%\\electron" & set "PATH=%windows_node_dir%;%PATH%" & set "HTTPS_PROXY=%WKTUI_PROXY%" & "%windows_npm_exe%" run build & cd "%WORKSPACE%"' + // bat 'cd "%WORKSPACE%\\webui" & set "PATH=%windows_node_dir%;%PATH%" & set "HTTPS_PROXY=%WKTUI_PROXY%" & "node_modules\\.bin\\ojet" build web --release & cd "%WORKSPACE%"' + // bat 'cd "%WORKSPACE%\\electron" & set "PATH=%windows_node_dir%;%PATH%" & set "HTTPS_PROXY=%WKTUI_PROXY%" & "%windows_node_exe%" scripts/installTools.js & cd "%WORKSPACE%"' + // bat 'cd "%WORKSPACE%\\electron" & set "PATH=%windows_node_dir%;%PATH%" & set "HTTPS_PROXY=%WKTUI_PROXY%" & "node_modules\\.bin\\electron-builder" -p never & cd "%WORKSPACE%"' archiveArtifacts 'dist/*.exe' archiveArtifacts "dist/*.blockmap" archiveArtifacts "dist/latest.yml" diff --git a/THIRD_PARTY_LICENSES.txt b/THIRD_PARTY_LICENSES.txt index e2f8bd516..0a5a76eff 100644 --- a/THIRD_PARTY_LICENSES.txt +++ b/THIRD_PARTY_LICENSES.txt @@ -13,11 +13,16 @@ Third Party Runtime Dependencies The following packages are licensed under The MIT License: -@babel/runtime@7.16.3 +@babel/runtime@7.17.7 Copyright (c) 2014-present Sebastian McKenzie and other contributors -@babel/runtime@7.16.7 -Copyright (c) 2014-present Sebastian McKenzie and other contributors +@colors/colors@1.5.0 +Original Library + - Copyright (c) Marak Squires + +Additional Functionality + - Copyright (c) Sindre Sorhus (sindresorhus.com) + - Copyright (c) DABH (https://github.com/DABH) @dabh/diagnostics@2.0.2 Copyright (c) 2015 Arnout Kazemier, Martijn Swaagman, the Contributors. @@ -37,8 +42,8 @@ Copyright (c) 2013 Nathan Rajlich ansi-regex@5.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -async@0.9.2 -Copyright (c) 2010-2014 Caolan McMahon +async@3.2.3 +Copyright (c) 2010-2018 Caolan McMahon base64-js@1.5.1 Copyright (c) 2014 Jameson Little @@ -70,13 +75,9 @@ Copyright (c) 2011-2016 Heather Arthur color-name@1.1.4 Copyright (c) 2015 Dmitry Ivanov -color-string@1.8.2 +color-string@1.9.0 Copyright (c) 2011 Heather Arthur -colors@1.0.3 -Original Library: Copyright (c) Marak Squires -Additional Functionality: Copyright (c) Sindre Sorhus (sindresorhus.com) - colorspace@1.1.4 Copyright (c) 2015 Arnout Kazemier, Martijn Swaagman, the Contributors. @@ -99,7 +100,7 @@ Copyright (c) 2015 TJ Holowaychuk duplexify@3.7.1 Copyright (c) 2014 Mathias Buus -electron-updater@4.6.5 +electron-updater@5.0.0 Copyright (c) 2015 Loopline Systems emoji-regex@8.0.0 @@ -117,7 +118,7 @@ Copyright (c) 2014 Andrew Kelley fecha@4.2.1 Copyright (c) 2015 Taylor Hakes -file-stream-rotator@0.5.7 +file-stream-rotator@0.6.1 Copyright(c) 2012-2017 Holiday Extras. Copyright(c) 2017 Roger C. @@ -145,10 +146,7 @@ Copyright (C) 2011-2014 by Jorik Tangelder (Eight Media) https-proxy-agent@5.0.0 Copyright (c) 2013 Nathan Rajlich -i18next@21.6.3 -Copyright (c) 2021 i18next - -i18next@21.6.7 +i18next@21.6.14 Copyright (c) 2022 i18next i18next-fs-backend@1.1.4 @@ -187,7 +185,7 @@ Copyright (C) 2011-2015 by Vitaly Puzrin jsonfile@4.0.0 Copyright (c) 2012-2015, JP Richardson -keytar@7.7.0 +keytar@7.9.0 Copyright (c) 2013 GitHub Inc. knockout@3.5.1 @@ -208,7 +206,7 @@ Copyright jQuery Foundation and other contributors lodash.isequal@4.5.0 Copyright JS Foundation and other contributors -logform@2.3.0 +logform@2.4.0 Copyright (c) 2017 Charlie Robbins & the Contributors. mgrs@1.0.0 @@ -217,7 +215,7 @@ Copyright (c) 2012, Mike Adair, Richard Greenwood, Didier Richard, Stephen Irons mimic-response@1.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -minimist@1.2.5 +minimist@1.2.6 No Copyright minizlib@2.1.2 @@ -231,7 +229,7 @@ Copyright James Halliday (mail@substack.net) and Isaac Z. Schlueter (i@izs.me) mkdirp-classic@0.5.3 Copyright (c) 2020 James Halliday (mail@substack.net) and Mathias Buus -moment@2.29.1 +moment@2.29.2 Copyright (c) JS Foundation and other contributors ms@2.1.2 @@ -240,7 +238,7 @@ Copyright (c) 2016 Zeit, Inc. napi-build-utils@1.0.2 Copyright (c) 2018 inspiredware -node-abi@2.30.1 +node-abi@3.8.0 Copyright (c) 2016 Lukas Geiger node-addon-api@1.7.2 @@ -258,25 +256,22 @@ Copyright (c) 2014 object-hash contributors one-time@1.0.0 Copyright (c) 2015 Unshift.io, Arnout Kazemier, the Contributors. -pako@0.2.9 -Copyright (C) 2014-2016 by Vitaly Puzrin - peek-stream@1.1.3 Copyright (c) 2014 Mathias Buus pend@1.2.0 Copyright (c) 2014 Andrew Kelley -preact@10.5.13 +preact@10.6.4 Copyright (c) 2015-present Jason Miller -prebuild-install@6.1.4 +prebuild-install@7.0.1 Copyright (c) 2015 Mathias Buus process-nextick-args@2.0.1 Copyright (c) 2015 Calvin Metcalf -proj4@2.7.2 +proj4@2.7.5 Copyright (c) 2014, Mike Adair, Richard Greenwood, Didier Richard, Stephen Irons, Olivier Terral and Calvin Metcalf pump@3.0.0 @@ -303,8 +298,8 @@ Copyright jQuery Foundation and other contributors, https://jquery.org/ safe-buffer@5.1.2 Copyright (c) Feross Aboukhadijeh -safe-stable-stringify@1.1.1 -Copyright (c) 2018 Ruben Bridgewater +safe-stable-stringify@2.3.1 +Copyright (c) Ruben Bridgewater set-immediate-shim@1.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -315,7 +310,7 @@ No Copyright simple-concat@1.0.1 Copyright (c) Feross Aboukhadijeh -simple-get@3.1.0 +simple-get@4.0.1 Copyright (c) Feross Aboukhadijeh simple-swizzle@0.2.2 @@ -369,13 +364,13 @@ Copyright (c) 2010-2020 Robert Kieffer and other contributors whatwg-url@5.0.0 Copyright (c) 2015–2016 Sebastian Mayr -winston@3.3.3 +winston@3.6.0 Copyright (c) 2010 Charlie Robbins -winston-daily-rotate-file@4.5.5 +winston-daily-rotate-file@4.6.1 Copyright (c) 2015 winstonjs -winston-transport@4.4.0 +winston-transport@4.5.0 Copyright (c) 2015 Charlie Robbins & the contributors. wkt-parser@1.3.2 @@ -387,22 +382,6 @@ Copyright (c) 2012-2014 Raynos. yauzl@2.10.0 Copyright (c) 2014 Josh Wolfe -#################################################################### -# Oracle elects to use the MIT license for the following packages. # -#################################################################### - -expand-template@2.0.3 -Copyright (c) 2018 Lars-Magnus Skog -license specification: (MIT OR WTFPL) - -jszip@3.7.1 -Copyright (c) 2009-2016 Stuart Knightley, David Duponchel, Franz Buchinger, António Afonso -license specification: (MIT OR GPL-3.0-or-later) - -rc@1.2.8 -Copyright (c) 2011 Dominic Tarr -license specification: (BSD-2-Clause OR MIT OR Apache-2.0) - The MIT License @@ -447,7 +426,7 @@ Copyright (c) Isaac Z. Schlueter and Contributors gauge@2.7.4 Copyright (c) 2014, Rebecca Turner -graceful-fs@4.2.8 +graceful-fs@4.2.9 Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors has-unicode@2.0.1 @@ -462,7 +441,7 @@ Copyright (c) Isaac Z. Schlueter and Contributors isexe@2.0.0 Copyright (c) Isaac Z. Schlueter and Contributors -minipass@3.1.5 +minipass@3.1.6 Copyright (c) npm, Inc. and Contributors npmlog@4.1.2 @@ -480,7 +459,7 @@ Copyright (c) Isaac Z. Schlueter and Contributors set-blocking@2.0.0 Copyright (c) 2016, Contributors -signal-exit@3.0.6 +signal-exit@3.0.7 Copyright (c) 2015, Contributors tar@6.1.11 @@ -535,7 +514,7 @@ PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 Licensee a nonexclusive, royalty-free, world-wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use Python alone or in any derivative version, provided, however, that - PSF's License Agreement and PSF's notice of copyright, i.e., "Copyright (c) + PSF's License Agreement and PSF's notice of copyright, i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights Reserved" are retained in Python alone or in any derivative version prepared by Licensee. @@ -752,9 +731,698 @@ POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- +The following packages are licensed under (MIT AND Zlib): + +pako@0.2.9 +Copyright (C) 2014-2017 by Vitaly Puzrin and Andrei Tuputcyn + + +The MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +++++++++++++++++++++ + + +zlib License + +This software is provided 'as-is', without any express +or implied warranty. In no event will the authors be held +liable for any damages arising from the use of this software. + +Permission is granted to anyone to use this software for any +purpose, including commercial applications, and to alter it and +redistribute it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; + you must not claim that you wrote the original software. + If you use this software in a product, an acknowledgment + in the product documentation would be appreciated but is + not required. + + 2. Altered source versions must be plainly marked as such, and + must not be misrepresented as being the original software. + + 3. This notice may not be removed or altered from any source + distribution. + + +-------------------------------------------------------------------------------- + + +The following packages are licensed under (MIT OR GPL-3.0-or-later): + +jszip@3.7.1 +Copyright (c) 2009-2016 Stuart Knightley, David Duponchel, Franz Buchinger, António Afonso + + +The MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +++++++++++++++++++++ + + +GNU General Public License v3.0 or later + +GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to +take away your freedom to share and change the works. By contrast, the GNU +General Public License is intended to guarantee your freedom to share and +change all versions of a program--to make sure it remains free software for +all its users. We, the Free Software Foundation, use the GNU General Public +License for most of our software; it applies also to any other work released +this way by its authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for them if you wish), that +you receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs, and that you know you can +do these things. + +To protect your rights, we need to prevent others from denying you these +rights or asking you to surrender the rights. Therefore, you have certain +responsibilities if you distribute copies of the software, or if you modify +it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must pass on to the recipients the same freedoms that you +received. You must make sure that they, too, receive or can get the source +code. And you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) +assert copyright on the software, and (2) offer you this License giving you +legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' +sake, the GPL requires that modified versions be marked as changed, so that +their problems will not be attributed erroneously to authors of previous +versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. +This is fundamentally incompatible with the aim of protecting users' +freedom to change the software. The systematic pattern of such abuse occurs +in the area of products for individuals to use, which is precisely where it +is most unacceptable. Therefore, we have designed this version of the GPL to +prohibit the practice for those products. If such problems arise +substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom +of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on +general-purpose computers, but in those that do, we wish to avoid the special +danger that patents applied to a free program could make it effectively +proprietary. To prevent this, the GPL assures that patents cannot be used to +render the program non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS + +0. Definitions. + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of + works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this + License. Each licensee is addressed as "you". "Licensees" and + "recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work in + a fashion requiring copyright permission, other than the making of an + exact copy. The resulting work is called a "modified version" of the + earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based on + the Program. + + To "propagate" a work means to do anything with it that, without + permission, would make you directly or secondarily liable for infringement + under applicable copyright law, except executing it on a computer or + modifying a private copy. Propagation includes copying, distribution (with + or without modification), making available to the public, and in some + countries other activities as well. + + To "convey" a work means any kind of propagation that enables other + parties to make or receive copies. Mere interaction with a user through a + computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" to the + extent that it includes a convenient and prominently visible feature that + (1) displays an appropriate copyright notice, and (2) tells the user that + there is no warranty for the work (except to the extent that warranties + are provided), that licensees may convey the work under this License, and + how to view a copy of this License. If the interface presents a list of + user commands or options, such as a menu, a prominent item in the list + meets this criterion. + +1. Source Code. + + The "source code" for a work means the preferred form of the work for + making modifications to it. "Object code" means any non-source form of a + work. + + A "Standard Interface" means an interface that either is an official + standard defined by a recognized standards body, or, in the case of + interfaces specified for a particular programming language, one that is + widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other than + the work as a whole, that (a) is included in the normal form of packaging + a Major Component, but which is not part of that Major Component, and (b) + serves only to enable use of the work with that Major Component, or to + implement a Standard Interface for which an implementation is available to + the public in source code form. A "Major Component", in this context, + means a major essential component (kernel, window system, and so on) of + the specific operating system (if any) on which the executable work runs, + or a compiler used to produce the work, or an object code interpreter used + to run it. + + The "Corresponding Source" for a work in object code form means all the + source code needed to generate, install, and (for an executable work) run + the object code and to modify the work, including scripts to control those + activities. However, it does not include the work's System Libraries, or + general-purpose tools or generally available free programs which are used + unmodified in performing those activities but which are not part of the + work. For example, Corresponding Source includes interface definition + files associated with source files for the work, and the source code for + shared libraries and dynamically linked subprograms that the work is + specifically designed to require, such as by intimate data communication + or control flow between those subprograms and other parts of the work. + + The Corresponding Source need not include anything that users can + regenerate automatically from other parts of the Corresponding Source. + + The Corresponding Source for a work in source code form is that same work. + +2. Basic Permissions. + + All rights granted under this License are granted for the term of + copyright on the Program, and are irrevocable provided the stated + conditions are met. This License explicitly affirms your unlimited + permission to run the unmodified Program. The output from running a + covered work is covered by this License only if the output, given its + content, constitutes a covered work. This License acknowledges your rights + of fair use or other equivalent, as provided by copyright law. + You may make, run and propagate covered works that you do not convey, + without conditions so long as your license otherwise remains in force. You + may convey covered works to others for the sole purpose of having them + make modifications exclusively for you, or provide you with facilities for + running those works, provided that you comply with the terms of this + License in conveying all material for which you do not control copyright. + Those thus making or running the covered works for you must do so + exclusively on your behalf, under your direction and control, on terms + that prohibit them from making any copies of your copyrighted material + outside their relationship with you. + + Conveying under any other circumstances is permitted solely under the + conditions stated below. Sublicensing is not allowed; section 10 makes it + unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological measure + under any applicable law fulfilling obligations under article 11 of the + WIPO copyright treaty adopted on 20 December 1996, or similar laws + prohibiting or restricting circumvention of such measures. + When you convey a covered work, you waive any legal power to forbid + circumvention of technological measures to the extent such circumvention + is effected by exercising rights under this License with respect to the + covered work, and you disclaim any intention to limit operation or + modification of the work as a means of enforcing, against the work's + users, your or third parties' legal rights to forbid circumvention of + technological measures. + +4. Conveying Verbatim Copies. + You may convey verbatim copies of the Program's source code as you + receive it, in any medium, provided that you conspicuously and + appropriately publish on each copy an appropriate copyright notice; + keep intact all notices stating that this License and any non-permissive + terms added in accord with section 7 apply to the code; keep intact all + notices of the absence of any warranty; and give all recipients a copy of + this License along with the Program. + You may charge any price or no price for each copy that you convey, and + you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to + produce it from the Program, in the form of source code under the terms of + section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified it, + and giving a relevant date. + + b) The work must carry prominent notices stating that it is released + under this License and any conditions added under section 7. This + requirement modifies the requirement in section 4 to "keep intact all + notices". + + c) You must license the entire work, as a whole, under this License to + anyone who comes into possession of a copy. This License will + therefore apply, along with any applicable section 7 additional + terms, to the whole of the work, and all its parts, regardless of how + they are packaged. This License gives no permission to license the + work in any other way, but it does not invalidate such permission if + you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your work + need not make them do so. + + A compilation of a covered work with other separate and independent works, + which are not by their nature extensions of the covered work, and which + are not combined with it such as to form a larger program, in or on a + volume of a storage or distribution medium, is called an "aggregate" if + the compilation and its resulting copyright are not used to limit the + access or legal rights of the compilation's users beyond what the + individual works permit. Inclusion of a covered work in an aggregate does + not cause this License to apply to the other parts of the aggregate. + +6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms of + sections 4 and 5, provided that you also convey the machine-readable + Corresponding Source under the terms of this License, in one of these + ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium customarily + used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a written + offer, valid for at least three years and valid for as long as you + offer spare parts or customer support for that product model, to give + anyone who possesses the object code either (1) a copy of the + Corresponding Source for all the software in the product that is + covered by this License, on a durable physical medium customarily + used for software interchange, for a price no more than your + reasonable cost of physically performing this conveying of source, + or (2) access to copy the Corresponding Source from a network server + at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This alternative + is allowed only occasionally and noncommercially, and only if you + received the object code with such an offer, in accord with + subsection 6b. + + d) Convey the object code by offering access from a designated place + (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) that + supports equivalent copying facilities, provided you maintain clear + directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided you + inform other peers where the object code and Corresponding Source of + the work are being offered to the general public at no charge under + subsection 6d. + A separable portion of the object code, whose source code is excluded + from the Corresponding Source as a System Library, need not be + included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any + tangible personal property which is normally used for personal, family, or + household purposes, or (2) anything designed or sold for incorporation + into a dwelling. In determining whether a product is a consumer product, + doubtful cases shall be resolved in favor of coverage. For a particular + product received by a particular user, "normally used" refers to a typical + or common use of that class of product, regardless of the status of the + particular user or of the way in which the particular user actually uses, + or expects or is expected to use, the product. A product is a consumer + product regardless of whether the product has substantial commercial, + industrial or non-consumer uses, unless such uses represent the only + significant mode of use of the product. + + "Installation Information" for a User Product means any methods, + procedures, authorization keys, or other information required to install + and execute modified versions of a covered work in that User Product from + a modified version of its Corresponding Source. The information must + suffice to ensure that the continued functioning of the modified object + code is in no case prevented or interfered with solely because + modification has been made. + + If you convey an object code work under this section in, or with, or + specifically for use in, a User Product, and the conveying occurs as part + of a transaction in which the right of possession and use of the User + Product is transferred to the recipient in perpetuity or for a fixed term + (regardless of how the transaction is characterized), the Corresponding + Source conveyed under this section must be accompanied by the Installation + Information. But this requirement does not apply if neither you nor any + third party retains the ability to install modified object code on the + User Product (for example, the work has been installed in ROM). + + The requirement to provide Installation Information does not include a + requirement to continue to provide support service, warranty, or updates + for a work that has been modified or installed by the recipient, or for + the User Product in which it has been modified or installed. Access to a + network may be denied when the modification itself materially and + adversely affects the operation of the network or violates the rules and + protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, in + accord with this section must be in a format that is publicly documented + (and with an implementation available to the public in source code form), + and must require no special password or key for unpacking, reading or + copying. + +7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this + License by making exceptions from one or more of its conditions. + Additional permissions that are applicable to the entire Program shall be + treated as though they were included in this License, to the extent that + they are valid under applicable law. If additional permissions apply only + to part of the Program, that part may be used separately under those + permissions, but the entire Program remains governed by this License + without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option remove + any additional permissions from that copy, or from any part of it. + (Additional permissions may be written to require their own removal in + certain cases when you modify the work.) You may place additional + permissions on material, added by you to a covered work, for which you + have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you add + to a covered work, you may (if authorized by the copyright holders of that + material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the terms + of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some trade + names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that material + by anyone who conveys the material (or modified versions of it) with + contractual assumptions of liability to the recipient, for any + liability that these contractual assumptions directly impose on those + licensors and authors. + + All other non-permissive additional terms are considered "further + restrictions" within the meaning of section 10. If the Program as you + received it, or any part of it, contains a notice stating that it is + governed by this License along with a term that is a further restriction, + you may remove that term. If a license document contains a further + restriction but permits relicensing or conveying under this License, you + may add to a covered work material governed by the terms of that license + document, provided that the further restriction does not survive such + relicensing or conveying. + + If you add terms to a covered work in accord with this section, you must + place, in the relevant source files, a statement of the additional terms + that apply to those files, or a notice indicating where to find the + applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the form + of a separately written license, or stated as exceptions; the above + requirements apply either way. + +8. Termination. + + You may not propagate or modify a covered work except as expressly + provided under this License. Any attempt otherwise to propagate or + modify it is void, and will automatically terminate your rights under + this License (including any patent licenses granted under the third + paragraph of section 11). + However, if you cease all violation of this License, then your license + from a particular copyright holder is reinstated (a) provisionally, unless + and until the copyright holder explicitly and finally terminates your + license, and (b) permanently, if the copyright holder fails to notify you + of the violation by some reasonable means prior to 60 days after the + cessation. + + Moreover, your license from a particular copyright holder is reinstated + permanently if the copyright holder notifies you of the violation by some + reasonable means, this is the first time you have received notice of + violation of this License (for any work) from that copyright holder, and + you cure the violation prior to 30 days after your receipt of the notice. + + Termination of your rights under this section does not terminate the + licenses of parties who have received copies or rights from you under this + License. If your rights have been terminated and not permanently + reinstated, you do not qualify to receive new licenses for the same + material under section 10. + +9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or run a + copy of the Program. Ancillary propagation of a covered work occurring + solely as a consequence of using peer-to-peer transmission to receive a + copy likewise does not require acceptance. However, nothing other than + this License grants you permission to propagate or modify any covered + work. These actions infringe copyright if you do not accept this License. + Therefore, by modifying or propagating a covered work, you indicate your + acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically receives + a license from the original licensors, to run, modify and propagate that + work, subject to this License. You are not responsible for enforcing + compliance by third parties with this License. + An "entity transaction" is a transaction transferring control of an + organization, or substantially all assets of one, or subdividing an + organization, or merging organizations. If propagation of a covered work + results from an entity transaction, each party to that transaction who + receives a copy of the work also receives whatever licenses to the work + the party's predecessor in interest had or could give under the previous + paragraph, plus a right to possession of the Corresponding Source of the + work from the predecessor in interest, if the predecessor has it or can + get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the rights + granted or affirmed under this License. For example, you may not impose a + license fee, royalty, or other charge for exercise of rights granted under + this License, and you may not initiate litigation (including a cross-claim + or counterclaim in a lawsuit) alleging that any patent claim is infringed + by making, using, selling, offering for sale, or importing the Program or + any portion of it. + +11. Patents. + + A "contributor" is a copyright holder who authorizes use under this + License of the Program or a work on which the Program is based. The work + thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims owned or + controlled by the contributor, whether already acquired or hereafter + acquired, that would be infringed by some manner, permitted by this + License, of making, using, or selling its contributor version, but do not + include claims that would be infringed only as a consequence of further + modification of the contributor version. For purposes of this definition, + "control" includes the right to grant patent sublicenses in a manner + consistent with the requirements of this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free + patent license under the contributor's essential patent claims, to make, + use, sell, offer for sale, import and otherwise run, modify and propagate + the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express + agreement or commitment, however denominated, not to enforce a patent + (such as an express permission to practice a patent or covenant not to sue + for patent infringement). To "grant" such a patent license to a party + means to make such an agreement or commitment not to enforce a patent + against the party. + + If you convey a covered work, knowingly relying on a patent license, and + the Corresponding Source of the work is not available for anyone to copy, + free of charge and under the terms of this License, through a publicly + available network server or other readily accessible means, then you must + either (1) cause the Corresponding Source to be so available, or (2) + arrange to deprive yourself of the benefit of the patent license for this + particular work, or (3) arrange, in a manner consistent with the + requirements of this License, to extend the patent license to downstream + recipients. "Knowingly relying" means you have actual knowledge that, but + for the patent license, your conveying the covered work in a country, or + your recipient's use of the covered work in a country, would infringe one + or more identifiable patents in that country that you have reason to + believe are valid. + + If, pursuant to or in connection with a single transaction or arrangement, + you convey, or propagate by procuring conveyance of, a covered work, and + grant a patent license to some of the parties receiving the covered work + authorizing them to use, propagate, modify or convey a specific copy of + the covered work, then the patent license you grant is automatically + extended to all recipients of the covered work and works based on it. + + A patent license is "discriminatory" if it does not include within the + scope of its coverage, prohibits the exercise of, or is conditioned on + the non-exercise of one or more of the rights that are specifically + granted under this License. You may not convey a covered work if you are + a party to an arrangement with a third party that is in the business of + distributing software, under which you make payment to the third party + based on the extent of your activity of conveying the work, and under + which the third party grants, to any of the parties who would receive the + covered work from you, a discriminatory patent license (a) in connection + with copies of the covered work conveyed by you (or copies made from those + copies), or (b) primarily for and in connection with specific products or + compilations that contain the covered work, unless you entered into that + arrangement, or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting any + implied license or other defenses to infringement that may otherwise be + available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot convey a + covered work so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you may + not convey it at all. For example, if you agree to terms that obligate you + to collect a royalty for further conveying from those to whom you convey + the Program, the only way you could satisfy both those terms and this + License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have permission + to link or combine any covered work with a work licensed under version 3 + of the GNU Affero General Public License into a single combined work, and + to convey the resulting work. The terms of this License will continue to + apply to the part which is the covered work, but the special requirements + of the GNU Affero General Public License, section 13, concerning + interaction through a network will apply to the combination as such. + +14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of + the GNU General Public License from time to time. Such new versions will + be similar in spirit to the present version, but may differ in detail to + address new problems or concerns. + Each version is given a distinguishing version number. If the Program + specifies that a certain numbered version of the GNU General Public + License "or any later version" applies to it, you have the option of + following the terms and conditions either of that numbered version or of + any later version published by the Free Software Foundation. If the + Program does not specify a version number of the GNU General Public + License, you may choose any version ever published by the Free Software + Foundation. + + If the Program specifies that a proxy can decide which future versions of + the GNU General Public License can be used, that proxy's public statement + of acceptance of a version permanently authorizes you to choose that + version for the Program. + + Later license versions may give you additional or different permissions. + However, no additional obligations are imposed on any author or copyright + holder as a result of your choosing to follow a later version. + +15. Disclaimer of Warranty. + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM + IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF + ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL + ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE + PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY + GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE + USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), + EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF + SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided above + cannot be given local legal effect according to their terms, reviewing + courts shall apply local law that most closely approximates an absolute + waiver of all civil liability in connection with the Program, unless a + warranty or assumption of liability accompanies a copy of the Program in + return for a fee. + + +-------------------------------------------------------------------------------- + + The following packages are licensed under Apache License, Version 2.0: -detect-libc@1.0.3 +detect-libc@2.0.0 Copyright 2017 Lovell Fuller tunnel-agent@0.6.0 @@ -931,13 +1599,63 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -------------------------------------------------------------------------------- -The following packages are licensed under The 3-Clause BSD License, Version 2.0: +The following packages are licensed under (MIT OR WTFPL): -ieee754@1.2.1 -Copyright 2008 Fair Oaks Labs, Inc. +expand-template@2.0.3 +Copyright (c) 2018 Lars-Magnus Skog -The 3-Clause BSD License, Version 2.0 +The MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +++++++++++++++++++++ + + +Do What The F*ck You Want To Public License + +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +Version 2, December 2004 + +Copyright (C) 2004 Sam Hocevar + +Everyone is permitted to copy and distribute verbatim +or modified copies of this license document, and +changing it is allowed as long as the name is changed. + +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. + + +-------------------------------------------------------------------------------- + + +The following packages are licensed under (BSD-2-Clause OR MIT OR Apache-2.0): + +rc@1.2.8 +Copyright (c) 2011 Dominic Tarr + + +The 2-Clause BSD License, Version 2.0 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -949,10 +1667,6 @@ are permitted provided that the following conditions are met: list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -3. Neither the name of the copyright holder 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -964,229 +1678,547 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWIS ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --------------------------------------------------------------------------------- - -The following packages are licensed under The Universal Permissive License (UPL), Version 1.0: +++++++++++++++++++++ -@oracle/oraclejet@11.1.5 -Copyright (c) 2022 Oracle and/or its affiliates. +The MIT License -The Universal Permissive License (UPL), Version 1.0 +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -Subject to the condition set forth below, permission is -hereby granted to any person obtaining a copy of this -software, associated documentation and/or data -(collectively the "Software"), free of charge and under -any and all copyright rights in the Software, and any -and all patent rights owned or freely licensable by -each licensor hereunder covering either (i) the -unmodified Software as contributed to or provided by -such licensor, or (ii) the Larger Works (as defined -below), to deal in both +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. - (a) the Software, and +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. - (b) any piece of software and/or hardware listed - in the lrgrwrks.txt file if one is included - with the Software (each a "Larger Work" to - which the Software is contributed by such - licensors), -without restriction, including without limitation -the rights to copy, create derivative works of, -display, perform, and distribute the Software and -make, use, sell, offer for sale, import, export, -have made, and have sold the Software and the Larger -Work(s), and to sublicense the foregoing rights on -either these or other terms. +++++++++++++++++++++ -This license is subject to the following condition: -The above copyright notice and either this complete -permission notice or at a minimum a reference to the -UPL must be included in all copies or substantial -portions of the Software. +Apache License, Version 2.0 -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY -OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT -LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES -OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ --------------------------------------------------------------------------------- +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Ace (Ajax.org Cloud9 Editor) 1.4.13 +1. Definitions. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. -Copyright (c) 2010, Ajax.org B.V. -All rights reserved. + "Licensor" shall mean the copyright owner or entity authorized by the + copyright owner that is granting the License. -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright - notice, this 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 Ajax.org B.V. nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. + "Legal Entity" shall mean the union of the acting entity and all other + entities that control, are controlled by, or are under common control with + that entity. For the purposes of this definition, "control" means (i) the + power, direct or indirect, to cause the direction or management of such + entity, whether by contract or otherwise, or (ii) ownership of fifty + percent (50%) or more of the outstanding shares, or (iii) beneficial + ownership of such entity. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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 AJAX.ORG B.V. 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. + "You" (or "Your") shall mean an individual or Legal Entity exercising + permissions granted by this License. --------------------------------------------------------------------------------- + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation source, + and configuration files. + "Object" form shall mean any form resulting from mechanical transformation + or translation of a Source form, including but not limited to compiled + object code, generated documentation, and conversions to other media types. -Third Party Development Code Dependencies -========================================= + "Work" shall mean the work of authorship, whether in Source or Object form, + made available under the License, as indicated by a copyright notice that + is included in or attached to the work (an example is provided in the + Appendix below). -The following packages are licensed under The MIT License: + "Derivative Works" shall mean any work, whether in Source or Object form, + that is based on (or derived from) the Work and for which the editorial + revisions, annotations, elaborations, or other modifications represent, + as a whole, an original work of authorship. For the purposes of this + License, Derivative Works shall not include works that remain separable + from, or merely link (or bind by name) to the interfaces of, the Work + and Derivative Works thereof. -@develar/schema-utils@2.6.5 -Copyright JS Foundation and other contributors + "Contribution" shall mean any work of authorship, including the original + version of the Work and any modifications or additions to that Work or + Derivative Works thereof, that is intentionally submitted to Licensor + for inclusion in the Work by the copyright owner or by an individual or + Legal Entity authorized to submit on behalf of the copyright owner. For + the purposes of this definition, "submitted" means any form of electronic, + verbal, or written communication sent to the Licensor or its + representatives, including but not limited to communication on electronic + mailing lists, source code control systems, and issue tracking systems + that are managed by, or on behalf of, the Licensor for the purpose of + discussing and improving the Work, but excluding communication that is + conspicuously marked or otherwise designated in writing by the copyright + owner as "Not a Contribution." -@electron/get@1.13.1 -Copyright (c) Contributors to the Electron project + "Contributor" shall mean Licensor and any individual or Legal Entity on + behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. -@electron/universal@1.0.5 -No Copyright +2. Grant of Copyright License. Subject to the terms and conditions of this + License, each Contributor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable copyright license to + reproduce, prepare Derivative Works of, publicly display, publicly + perform, sublicense, and distribute the Work and such Derivative Works + in Source or Object form. -@eslint/eslintrc@1.0.5 -Copyright (c) 2020 ESLint +3. Grant of Patent License. Subject to the terms and conditions of this + License, each Contributor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable (except as stated + in this section) patent license to make, have made, use, offer to sell, + sell, import, and otherwise transfer the Work, where such license applies + only to those patent claims licensable by such Contributor that are + necessarily infringed by their Contribution(s) alone or by combination + of their Contribution(s) with the Work to which such Contribution(s) was + submitted. If You institute patent litigation against any entity + (including a cross-claim or counterclaim in a lawsuit) alleging that the + Work or a Contribution incorporated within the Work constitutes direct or + contributory patent infringement, then any patent licenses granted to You + under this License for that Work shall terminate as of the date such + litigation is filed. -@malept/flatpak-bundler@0.4.0 -Copyright (c) 2016 Endless Mobile, Inc. +4. Redistribution. You may reproduce and distribute copies of the Work or + Derivative Works thereof in any medium, with or without modifications, + and in Source or Object form, provided that You meet the following conditions: -@nodelib/fs.scandir@2.1.5 -Copyright (c) Denis Malinochkin + (a) You must give any other recipients of the Work or Derivative Works a + copy of this License; and -@nodelib/fs.stat@2.0.5 -Copyright (c) Denis Malinochkin + (b) You must cause any modified files to carry prominent notices stating + that You changed the files; and -@nodelib/fs.walk@1.2.8 -Copyright (c) Denis Malinochkin + (c) You must retain, in the Source form of any Derivative Works that You + distribute, all copyright, patent, trademark, and attribution notices + from the Source form of the Work, excluding those notices that do not + pertain to any part of the Derivative Works; and -@sindresorhus/is@0.14.0 -Copyright (c) Sindre Sorhus (sindresorhus.com) + (d) If the Work includes a "NOTICE" text file as part of its distribution, + then any Derivative Works that You distribute must include a readable + copy of the attribution notices contained within such NOTICE file, + excluding those notices that do not pertain to any part of the + Derivative Works, in at least one of the following places: within a + NOTICE text file distributed as part of the Derivative Works; within + the Source form or documentation, if provided along with the Derivative + Works; or, within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents of the + NOTICE file are for informational purposes only and do not modify the + License. You may add Your own attribution notices within Derivative + Works that You distribute, alongside or as an addendum to the NOTICE + text from the Work, provided that such additional attribution notices + cannot be construed as modifying the License. + You may add Your own copyright statement to Your modifications and may + provide additional or different license terms and conditions for use, + reproduction, or distribution of Your modifications, or for any such + Derivative Works as a whole, provided Your use, reproduction, and + distribution of the Work otherwise complies with the conditions stated + in this License. -@szmarczak/http-timer@1.1.2 -Copyright (c) 2018 Szymon Marczak +5. Submission of Contributions. Unless You explicitly state otherwise, any + Contribution intentionally submitted for inclusion in the Work by You to + the Licensor shall be under the terms and conditions of this License, + without any additional terms or conditions. Notwithstanding the above, + nothing herein shall supersede or modify the terms of any separate license + agreement you may have executed with Licensor regarding such Contributions. -@tootallnate/once@2.0.0 -Copyright (c) 2020 Nathan Rajlich +6. Trademarks. This License does not grant permission to use the trade names, + trademarks, service marks, or product names of the Licensor, except as + required for reasonable and customary use in describing the origin of the + Work and reproducing the content of the NOTICE file. -@types/concat-stream@1.6.1 -Copyright (c) Microsoft Corporation. +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in + writing, Licensor provides the Work (and each Contributor provides its + Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF + ANY KIND, either express or implied, including, without limitation, any + warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or + FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for + determining the appropriateness of using or redistributing the Work and + assume any risks associated with Your exercise of permissions under this + License. -@types/debug@4.1.7 -Copyright (c) Microsoft Corporation. +8. Limitation of Liability. In no event and under no legal theory, whether + in tort (including negligence), contract, or otherwise, unless required by + applicable law (such as deliberate and grossly negligent acts) or agreed + to in writing, shall any Contributor be liable to You for damages, + including any direct, indirect, special, incidental, or consequential + damages of any character arising as a result of this License or out of + the use or inability to use the Work (including but not limited to damages + for loss of goodwill, work stoppage, computer failure or malfunction, or + any and all other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. -@types/form-data@0.0.33 -Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and contributors +9. Accepting Warranty or Additional Liability. While redistributing the Work + or Derivative Works thereof, You may choose to offer, and charge a fee + for, acceptance of support, warranty, indemnity, or other liability + obligations and/or rights consistent with this License. However, in + accepting such obligations, You may act only on Your own behalf and on + Your sole responsibility, not on behalf of any other Contributor, and + only if You agree to indemnify, defend, and hold each Contributor harmless + for any liability incurred by, or claims asserted against, such + Contributor by reason of your accepting any such warranty or additional + liability. -@types/fs-extra@9.0.13 -Copyright (c) Microsoft Corporation. -@types/ms@0.7.31 -Copyright (c) Microsoft Corporation. All rights reserved. +-------------------------------------------------------------------------------- -@types/node@14.17.34 -Copyright (c) Microsoft Corporation. -@types/node@10.17.60 -Copyright (c) Microsoft Corporation. +The following packages are licensed under The 3-Clause BSD License, Version 2.0: -@types/q@1.5.5 -Copyright (c) Microsoft Corporation. +ieee754@1.2.1 +Copyright 2008 Fair Oaks Labs, Inc. -@types/qs@6.9.7 -Copyright (c) Microsoft Corporation. -@types/yargs@17.0.7 -Copyright (c) Microsoft Corporation. +The 3-Clause BSD License, Version 2.0 -@types/yargs-parser@20.2.1 -Copyright (c) Microsoft Corporation. +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: -@typescript-eslint/types@4.9.1 -Copyright (c) 2019 TypeScript ESLint and other contributors +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. -@typescript-eslint/visitor-keys@4.9.1 -Copyright (c) 2019 TypeScript ESLint and other contributors +2. 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. -7zip-bin@5.1.1 -Copyright (c) 2016 Vladimir Krivosheev +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. -accepts@1.3.7 -Copyright (c) 2014 Jonathan Ong -Copyright (c) 2015 Douglas Christopher Wilson +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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. -acorn@8.6.0 -Copyright (C) 2012-2020 by various contributors (see AUTHORS) +-------------------------------------------------------------------------------- -acorn@7.4.1 -Copyright (C) 2012-2018 by various contributors (see AUTHORS) -acorn-globals@6.0.0 -Copyright (c) 2014 Forbes Lindesay +The following packages are licensed under The Universal Permissive License (UPL), Version 1.0: -acorn-jsx@5.3.2 -Copyright (C) 2012-2017 by Ingvar Stepanyan +@oracle/oraclejet@12.1.1 +Copyright (c) 2022 Oracle and/or its affiliates. -acorn-walk@7.2.0 -Copyright (C) 2012-2018 by various contributors (see AUTHORS) +@oracle/wrc-jet-pack@2.3.0-develop.202205080232 +Copyright (c) 2022 Oracle and/or its affiliates. -adm-zip@0.4.16 -Copyright (c) 2012 Another-D-Mention Software and other contributors, -agent-base@6.0.2 -Copyright (c) 2013 Nathan Rajlich +The Universal Permissive License (UPL), Version 1.0 -ajv@6.12.6 -Copyright (c) 2015-2017 Evgeny Poberezkin +Subject to the condition set forth below, permission is +hereby granted to any person obtaining a copy of this +software, associated documentation and/or data +(collectively the "Software"), free of charge and under +any and all copyright rights in the Software, and any +and all patent rights owned or freely licensable by +each licensor hereunder covering either (i) the +unmodified Software as contributed to or provided by +such licensor, or (ii) the Larger Works (as defined +below), to deal in both -ajv-keywords@3.5.2 -Copyright (c) 2016 Evgeny Poberezkin + (a) the Software, and -ansi-colors@4.1.1 -Copyright (c) 2015-present, Brian Woodward. + (b) any piece of software and/or hardware listed + in the lrgrwrks.txt file if one is included + with the Software (each a "Larger Work" to + which the Software is contributed by such + licensors), -ansi-escapes@3.2.0 -Copyright (c) Sindre Sorhus (sindresorhus.com) +without restriction, including without limitation +the rights to copy, create derivative works of, +display, perform, and distribute the Software and +make, use, sell, offer for sale, import, export, +have made, and have sold the Software and the Larger +Work(s), and to sublicense the foregoing rights on +either these or other terms. -ansi-regex@5.0.1 -Copyright (c) Sindre Sorhus (sindresorhus.com) +This license is subject to the following condition: -ansi-styles@4.3.0 -Copyright (c) Sindre Sorhus (sindresorhus.com) +The above copyright notice and either this complete +permission notice or at a minimum a reference to the +UPL must be included in all copies or substantial +portions of the Software. -app-builder-bin@3.7.1 -No Copyright +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY +OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES +OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + +-------------------------------------------------------------------------------- + + +Ace (Ajax.org Cloud9 Editor) 1.4.14 + +Copyright (c) 2010, Ajax.org B.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: +* Redistributions of source code must retain the above copyright +notice, this 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 Ajax.org B.V. 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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 AJAX.ORG B.V. 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. + + +-------------------------------------------------------------------------------- + + +Third Party Development Code Dependencies +========================================= + +The following packages are licensed under The MIT License: + +@babel/code-frame@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/compat-data@7.17.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/core@7.17.8 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/generator@7.17.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-compilation-targets@7.17.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-environment-visitor@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-function-name@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-get-function-arity@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-hoist-variables@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-module-imports@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-module-transforms@7.17.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-simple-access@7.17.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-split-export-declaration@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-validator-identifier@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helper-validator-option@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/helpers@7.17.8 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/highlight@7.16.10 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/parser@7.17.8 +Copyright (C) 2012-2014 by various contributors (see AUTHORS) + +@babel/template@7.16.7 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/traverse@7.17.3 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@babel/types@7.17.0 +Copyright (c) 2014-present Sebastian McKenzie and other contributors + +@develar/schema-utils@2.6.5 +Copyright JS Foundation and other contributors + +@electron/get@1.13.1 +Copyright (c) Contributors to the Electron project + +@electron/universal@1.0.5 +No Copyright + +@eslint/eslintrc@1.2.1 +Copyright (c) 2020 ESLint + +@istanbuljs/schema@0.1.3 +Copyright (c) 2019 CFWare, LLC + +@jridgewell/resolve-uri@3.0.5 +Copyright 2019 Justin Ridgewell + +@jridgewell/sourcemap-codec@1.4.11 +Copyright (c) 2015 Rich Harris + +@jridgewell/trace-mapping@0.3.4 +Copyright 2022 Justin Ridgewell + +@malept/flatpak-bundler@0.4.0 +Copyright (c) 2016 Endless Mobile, Inc. + +@nodelib/fs.scandir@2.1.5 +Copyright (c) Denis Malinochkin + +@nodelib/fs.stat@2.0.5 +Copyright (c) Denis Malinochkin + +@nodelib/fs.walk@1.2.8 +Copyright (c) Denis Malinochkin + +@sindresorhus/is@0.14.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +@szmarczak/http-timer@1.1.2 +Copyright (c) 2018 Szymon Marczak + +@tootallnate/once@2.0.0 +Copyright (c) 2020 Nathan Rajlich + +@types/concat-stream@1.6.1 +Copyright (c) Microsoft Corporation. + +@types/debug@4.1.7 +Copyright (c) Microsoft Corporation. + +@types/form-data@0.0.33 +Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and contributors + +@types/fs-extra@9.0.13 +Copyright (c) Microsoft Corporation. + +@types/ms@0.7.31 +Copyright (c) Microsoft Corporation. All rights reserved. + +@types/node@14.18.10 +Copyright (c) Microsoft Corporation. + +@types/node@10.17.60 +Copyright (c) Microsoft Corporation. + +@types/qs@6.9.7 +Copyright (c) Microsoft Corporation. + +@types/yargs@17.0.8 +Copyright (c) Microsoft Corporation. + +@types/yargs-parser@20.2.1 +Copyright (c) Microsoft Corporation. + +@typescript-eslint/types@4.9.1 +Copyright (c) 2019 TypeScript ESLint and other contributors + +@typescript-eslint/visitor-keys@4.9.1 +Copyright (c) 2019 TypeScript ESLint and other contributors + +7zip-bin@5.1.1 +Copyright (c) 2016 Vladimir Krivosheev + +accepts@1.3.8 +Copyright (c) 2014 Jonathan Ong +Copyright (c) 2015 Douglas Christopher Wilson + +acorn@8.7.0 +Copyright (C) 2012-2020 by various contributors (see AUTHORS) + +acorn@7.4.1 +Copyright (C) 2012-2018 by various contributors (see AUTHORS) + +acorn-globals@6.0.0 +Copyright (c) 2014 Forbes Lindesay + +acorn-jsx@5.3.2 +Copyright (C) 2012-2017 by Ingvar Stepanyan + +acorn-walk@7.2.0 +Copyright (C) 2012-2018 by various contributors (see AUTHORS) + +adm-zip@0.4.16 +Copyright (c) 2012 Another-D-Mention Software and other contributors, + +agent-base@6.0.2 +Copyright (c) 2013 Nathan Rajlich + +aggregate-error@3.1.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +ajv@6.12.6 +Copyright (c) 2015-2017 Evgeny Poberezkin + +ajv-keywords@3.5.2 +Copyright (c) 2016 Evgeny Poberezkin + +ansi-colors@4.1.1 +Copyright (c) 2015-present, Brian Woodward. + +ansi-escapes@3.2.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +ansi-regex@5.0.1 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +ansi-styles@4.3.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +app-builder-bin@3.7.1 +Copyright (c) 2015 Loopline Systems -app-builder-lib@22.14.12 +app-builder-lib@22.14.13 Copyright (c) 2015 Loopline Systems +append-transform@2.0.0 +Copyright (c) James Talmage (github.com/jamestalmage) + archiver@5.2.0 Copyright (c) 2012-2014 Chris Talkington, contributors. archiver-utils@2.1.0 Copyright (c) 2015 Chris Talkington. +archy@1.0.0 +No Copyright + array-flatten@1.1.1 Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com) @@ -1202,9 +2234,6 @@ Copyright (c) 2014 GitHub Inc. assertion-error@1.1.0 Copyright (c) 2013 Jake Luer jake@qualiancy.com (http://qualiancy.com) -async@0.9.2 -Copyright (c) 2010-2014 Caolan McMahon - async@3.2.3 Copyright (c) 2010-2018 Caolan McMahon @@ -1251,6 +2280,9 @@ Copyright (c) 2013 Julian Gruber braces@3.0.2 Copyright (c) 2014-2018, Jon Schlinkert. +browserslist@4.20.2 +Copyright 2014 Andrey Sitnik and other contributors + buffer@5.7.1 Copyright (c) Feross Aboukhadijeh, and other contributors. @@ -1263,7 +2295,7 @@ No Copyright buffer-from@1.1.2 Copyright (c) 2016, 2018 Linus Unnebäck -builder-util@22.14.7 +builder-util@22.14.13 Copyright (c) 2015 Loopline Systems builder-util-runtime@8.9.2 @@ -1276,8 +2308,8 @@ Copyright (c) 2015 Jed Watson cacheable-request@6.1.0 Copyright (c) 2017 Luke Childs -call-bind@1.0.2 -Copyright (c) 2020 Jordan Harband +caching-transform@4.0.0 +Copyright (c) James Talmage (github.com/jamestalmage) callsite@1.0.0 No Copyright @@ -1285,10 +2317,10 @@ No Copyright callsites@3.1.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -camelcase@6.2.1 +camelcase@6.3.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -chai@4.3.4 +chai@4.3.6 Copyright (c) 2017 Chai.js Assertion Library chalk@4.1.2 @@ -1300,7 +2332,7 @@ Copyright (C) 2018 Dmitry Shirokov check-error@1.0.2 Copyright (c) 2013 Jake Luer (http://alogicalparadox.com) -chokidar@3.5.2 +chokidar@3.5.3 Copyright (c) 2012-2019 Paul Miller (https://paulmillr.com), Elan Shanker chromium-pickle-js@0.2.0 @@ -1309,6 +2341,9 @@ No Copyright ci-info@3.3.0 Copyright (c) 2016-2021 Thomas Watson Steen +clean-stack@2.2.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + cli-boxes@2.2.1 Copyright (c) Sindre Sorhus (https://sindresorhus.com) @@ -1318,9 +2353,6 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) clone-response@1.0.2 Copyright (c) 2017 Luke Childs -coa@2.0.2 -Copyright (c) 2015-present Sergey Berezhnoy - color-convert@2.0.1 Copyright (c) 2011-2016 Heather Arthur @@ -1337,9 +2369,12 @@ Copyright (c) 2011 Debuggable Limited commander@5.1.0 Copyright (c) 2011 TJ Holowaychuk -commander@2.20.3 +commander@7.2.0 Copyright (c) 2011 TJ Holowaychuk +commondir@1.0.1 +Copyright (c) 2013 James Halliday (mail@substack.net) + compare-version@0.1.2 Copyright © Kevin Mårtensson @@ -1370,6 +2405,9 @@ Copyright (c) 2015 Douglas Christopher Wilson continuable-cache@0.3.1 Copyright (c) 2013 Colingo. +convert-source-map@1.8.0 +Copyright 2013 Thorsten Lorenz. + cookie@0.4.1 Copyright (c) 2012-2014 Roman Shtylman Copyright (c) 2015 Douglas Christopher Wilson @@ -1386,17 +2424,12 @@ Copyright (c) 2018 Made With MOXY Lda crypto-random-string@2.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -css-select-base-adapter@0.1.1 -Copyright (c) 2018 Nik Coughlin - css-tree@1.0.0-alpha.39 Copyright (C) 2016-2019 by Roman Dvornov -css-url-regex@1.1.0 -Copyright (c) John Otander (johnotander.com) - -csso@3.5.1 -Copyright (C) 2011-2017 by Sergey Kryzhanovsky +csso@4.2.0 +Copyright (C) 2015-2019 by Roman Dvornov +Copyright (C) 2011-2015 by Sergey Kryzhanovsky cssom@0.5.0 Copyright (c) Nikita Vasilyev @@ -1434,12 +2467,12 @@ Copyright (c) 2012, 2013 Thorsten Lorenz Copyright (c) 2012 James Halliday Copyright (c) 2009 Thomas Robinson <280north.com> +default-require-extensions@3.0.0 +Copyright (c) Node.js contributors, James Talmage (github.com/jamestalmage) + defer-to-connect@1.1.3 Copyright (c) 2018 Szymon Marczak -define-properties@1.1.3 -Copyright (C) 2015 Jordan Harband - delayed-stream@1.0.0 Copyright (c) 2011 Debuggable Limited @@ -1455,7 +2488,7 @@ Copyright 2014 Liviu Grigorescu (grigoresculiviu@gmail.com) dir-glob@3.0.1 Copyright (c) Kevin Mårtensson (github.com/kevva) -dmg-builder@22.14.12 +dmg-builder@22.14.13 Copyright (c) 2015 Loopline Systems dom-serializer@0.2.2 @@ -1470,17 +2503,17 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) ee-first@1.1.1 Copyright (c) 2014 Jonathan Ong me@jongleberry.com -electron@16.0.5 +electron@17.4.3 Copyright (c) Electron contributors Copyright (c) 2013-2020 GitHub Inc. -electron-builder@22.14.12 +electron-builder@22.14.13 Copyright (c) 2015 Loopline Systems electron-notarize@1.1.1 Copyright 2018 Samuel Attard and contributors -electron-publish@22.14.12 +electron-publish@22.14.13 Copyright (c) 2015 Loopline Systems emoji-regex@8.0.0 @@ -1492,20 +2525,14 @@ Copyright (c) 2016 Douglas Christopher Wilson end-of-stream@1.4.4 Copyright (c) 2014 Mathias Buus -enquirer@2.3.6 -Copyright (c) 2016-present, Jon Schlinkert. - env-paths@2.2.1 Copyright (c) Sindre Sorhus (sindresorhus.com) error@7.2.1 No Copyright -es-abstract@1.19.1 -Copyright (C) 2015 Jordan Harband - -es-to-primitive@1.2.1 -Copyright (c) 2015 Jordan Harband +es6-error@4.1.1 +Copyright (c) 2015 Ben Youngblood escalade@3.1.1 Copyright (c) Luke Edwards (lukeed.com) @@ -1521,10 +2548,7 @@ Copyright (c) 2015 Tiancheng "Timothy" Gu escape-string-regexp@4.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -eslint@8.5.0 -Copyright OpenJS Foundation and other contributors, - -eslint@8.7.0 +eslint@8.11.0 Copyright OpenJS Foundation and other contributors, eslint-plugin-requirejs@4.0.1 @@ -1578,6 +2602,9 @@ Copyright (c) 2014-present, Jon Schlinkert. finalhandler@1.1.2 Copyright (c) 2014-2017 Douglas Christopher Wilson +find-cache-dir@3.3.2 +Copyright (c) Sindre Sorhus (https://sindresorhus.com) + find-up@5.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) @@ -1597,6 +2624,9 @@ fresh@0.5.2 Copyright (c) 2012 TJ Holowaychuk Copyright (c) 2016-2017 Douglas Christopher Wilson +fromentries@1.3.2 +Copyright (c) Feross Aboukhadijeh + fs-constants@1.0.0 Copyright (c) 2018 Mathias Buus @@ -1612,11 +2642,14 @@ Copyright (c) 2013 Mikola Lysenko gaze@1.1.3 Copyright (c) 2018 Kyle Robinson Young +gensync@1.0.0-beta.2 +Copyright 2018 Logan Smyth + get-func-name@2.0.0 Copyright (c) 2013 Jake Luer (http://alogicalparadox.com) -get-intrinsic@1.1.1 -Copyright (c) 2020 Jordan Harband +get-package-type@0.1.0 +Copyright (c) 2020 CFWare, LLC get-port@3.2.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -1624,13 +2657,10 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) get-stream@5.2.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -get-symbol-description@1.0.0 -Copyright (c) 2021 Inspect JS - global-dirs@3.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -globals@13.12.0 +globals@13.13.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) globby@11.1.0 @@ -1649,27 +2679,24 @@ Copyright (c) 2016 Joshua Boy Nicolai Appelman joshua@jbna.nl has@1.0.3 Copyright (c) 2013 Thiago de Arruda -has-bigints@1.0.1 -Copyright (c) 2019 Jordan Harband - has-flag@4.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -has-symbols@1.0.2 -Copyright (c) 2016 Jordan Harband - -has-tostringtag@1.0.0 -Copyright (c) 2021 Inspect JS - has-yarn@2.1.0 Copyright (c) Sindre Sorhus (sindresorhus.com) +hasha@5.2.2 +Copyright (c) Sindre Sorhus (https://sindresorhus.com) + he@1.2.0 Copyright Mathias Bynens html-encoding-sniffer@3.0.0 Copyright © Domenic Denicola +html-escaper@2.0.2 +Copyright (C) 2017-present by Andrea Giammarchi - @WebReflection + htmlparser2@3.10.1 Copyright 2010, 2011, Chris Winberry . All rights reserved. @@ -1698,9 +2725,6 @@ Copyright (c) 2011 Alexander Shtuchkin iconv-lite@0.4.24 Copyright (c) 2011 Alexander Shtuchkin -ignore@4.0.6 -Copyright (c) 2013 Kael Zhang , contributors - ignore@5.2.0 Copyright (c) 2013 Kael Zhang , contributors @@ -1713,39 +2737,27 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) imurmurhash@0.1.4 Copyright (c) 2013 Gary Court, Jens Taylor +indent-string@4.0.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + inquirer@6.2.2 Copyright (c) 2012 Simon Boudrias -internal-slot@1.0.3 -Copyright (c) 2019 Jordan Harband - ipaddr.js@1.9.1 Copyright (C) 2011-2017 whitequark -is-bigint@1.0.4 -Copyright (c) 2018 Jordan Harband - is-binary-path@2.1.0 Copyright (c) 2019 Sindre Sorhus (https://sindresorhus.com), Paul Miller (https://paulmillr.com) -is-boolean-object@1.1.2 -Copyright (c) 2015 Jordan Harband - is-buffer@1.1.6 Copyright (c) Feross Aboukhadijeh -is-callable@1.2.4 -Copyright (c) 2015 Jordan Harband - is-ci@3.0.1 Copyright (c) 2016-2021 Thomas Watson Steen -is-core-module@2.8.0 +is-core-module@2.8.1 Copyright (c) 2014 Dave Justice -is-date-object@1.0.5 -Copyright (c) 2015 Jordan Harband - is-extglob@2.1.1 Copyright (c) 2014-2016, Jon Schlinkert @@ -1761,18 +2773,12 @@ Copyright (c) 2014-2017, Jon Schlinkert. is-installed-globally@0.4.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -is-negative-zero@2.0.2 -Copyright (c) 2014 Jordan Harband - is-npm@5.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) is-number@7.0.0 Copyright (c) 2014-present, Jon Schlinkert. -is-number-object@1.0.6 -Copyright (c) 2015 Jordan Harband - is-obj@2.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -1788,17 +2794,8 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) is-potential-custom-element-name@1.0.1 Copyright Mathias Bynens -is-regex@1.1.4 -Copyright (c) 2014 Jordan Harband - -is-shared-array-buffer@1.0.1 -Copyright (c) 2021 Inspect JS - -is-string@1.0.7 -Copyright (c) 2015 Jordan Harband - -is-symbol@1.0.4 -Copyright (c) 2015 Jordan Harband +is-stream@2.0.1 +Copyright (c) Sindre Sorhus (https://sindresorhus.com) is-typedarray@1.0.0 No Copyright @@ -1806,8 +2803,8 @@ No Copyright is-unicode-supported@0.1.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -is-weakref@1.0.2 -Copyright (c) 2020 Inspect JS +is-windows@1.0.2 +Copyright (c) 2015-2018, Jon Schlinkert. is-wsl@1.1.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -1818,12 +2815,18 @@ Copyright (c) 2018 LitoMore isbinaryfile@4.0.8 Copyright (c) 2019 Garen J. Torikian +js-tokens@4.0.0 +Copyright (c) 2014, 2015, 2016, 2017, 2018 Simon Lydell + js-yaml@4.1.0 Copyright (C) 2011-2015 by Vitaly Puzrin jsdom@19.0.0 Copyright (c) 2010 Elijah Insua +jsesc@2.5.2 +Copyright Mathias Bynens + json-buffer@3.0.0 Copyright (c) 2013 Dominic Tarr @@ -1857,6 +2860,9 @@ Copyright (c) 2013 J. Pommerening, contributors. levn@0.4.1 Copyright (c) George Zahariev +linkify-it@3.0.3 +Copyright (c) 2015 Vitaly Puzrin. + livereload-js@2.4.0 Copyright (c) 2010-2012 Andrey Tarantsov @@ -1878,6 +2884,9 @@ Copyright jQuery Foundation and other contributors lodash.flatten@4.4.0 Copyright jQuery Foundation and other contributors +lodash.flattendeep@4.4.0 +Copyright jQuery Foundation and other contributors + lodash.isfunction@3.0.9 Copyright JS Foundation and other contributors @@ -1899,13 +2908,22 @@ Copyright jQuery Foundation and other contributors log-symbols@4.1.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) +loupe@2.3.3 +Copyright (c) 2011-2013 Jake Luer jake@alogicalparadox.com + lowercase-keys@1.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) make-dir@3.1.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -media-typer@0.3.0 +markdown-it@12.2.0 +Copyright (c) 2014 Vitaly Puzrin, Alex Kocharin. + +mdurl@1.0.1 +Copyright (c) 2015 Vitaly Puzrin, Alex Kocharin. + +media-typer@0.3.0 Copyright (c) 2014 Douglas Christopher Wilson merge-descriptors@1.0.1 @@ -1941,16 +2959,13 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) mimic-response@1.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -minimist@1.2.5 +minimist@1.2.6 No Copyright mkdirp@0.5.5 Copyright 2010 James Halliday (mail@substack.net) -mocha@9.1.3 -Copyright (c) 2011-2021 OpenJS Foundation and contributors, https://openjsf.org - -mocha@9.1.4 +mocha@9.2.2 Copyright (c) 2011-2022 OpenJS Foundation and contributors, https://openjsf.org mock-http-server@1.4.2 @@ -1967,17 +2982,26 @@ Copyright (c) 2013 Felix Geisendörfer Copyright (c) 2014 Andrew Kelley Copyright (c) 2014 Douglas Christopher Wilson -nanoid@3.1.25 +nanocolors@0.1.12 +Copyright 2021 Jorge Bucaran , + +nanoid@3.3.1 Copyright 2017 Andrey Sitnik natural-compare@1.4.0 Copyright (c) 2012-2015 Lauri Rooden -negotiator@0.6.2 +negotiator@0.6.3 Copyright (c) 2012-2014 Federico Romero Copyright (c) 2012-2014 Isaac Z. Schlueter Copyright (c) 2014-2015 Douglas Christopher Wilson +node-preload@0.2.1 +Copyright (c) 2019 CFWare, LLC + +node-releases@2.0.2 +Copyright (c) 2017 Sergey Rubanov (https://github.com/chicoxyzzy) + normalize-path@3.0.0 Copyright (c) 2014-2018, Jon Schlinkert. @@ -1990,21 +3014,6 @@ Copyright (c) 2007-2019 Diego Perini (http://www.iport.it/) object-assign@4.1.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -object-inspect@1.12.0 -Copyright (c) 2013 James Halliday - -object-keys@1.1.1 -Copyright (C) 2013 Jordan Harband - -object.assign@4.1.2 -Copyright (c) 2014 Jordan Harband - -object.getownpropertydescriptors@2.1.3 -Copyright (c) 2015 Jordan Harband - -object.values@1.1.5 -Copyright (c) 2015 Jordan Harband - on-finished@2.3.0 Copyright (c) 2013 Jonathan Ong Copyright (c) 2014 Douglas Christopher Wilson @@ -2030,6 +3039,9 @@ Copyright (c) Sindre Sorhus (https://sindresorhus.com) p-locate@5.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) +p-map@3.0.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + package-json@6.5.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -2070,13 +3082,13 @@ Copyright (c) 2011-2013 Jake Luer jake@alogicalparadox.com pend@1.2.0 Copyright (c) 2014 Andrew Kelley -picomatch@2.3.0 -Copyright (c) 2017-present, Jon Schlinkert. - picomatch@2.3.1 Copyright (c) 2017-present, Jon Schlinkert. -plist@3.0.4 +pkg-dir@4.2.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + +plist@3.0.5 Copyright (c) 2010-2017 Nathan Rajlich prelude-ls@1.2.1 @@ -2085,6 +3097,9 @@ Copyright (c) George Zahariev prepend-http@2.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) +process-on-spawn@1.0.0 +Copyright (c) 2019 CFWare, LLC + progress@2.0.3 Copyright (c) 2017 TJ Holowaychuk @@ -2109,9 +3124,6 @@ Copyright Mathias Bynens pupa@2.1.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -q@1.5.1 -Copyright 2009–2017 Kristopher Michael Kowal. All rights reserved. - queue-microtask@1.2.3 Copyright (c) Feross Aboukhadijeh @@ -2156,7 +3168,7 @@ Copyright (c) 2011 Troy Goode requirejs@2.3.6 Copyright jQuery Foundation and other contributors, https://jquery.org/ -resolve@1.20.0 +resolve@1.22.0 Copyright (c) 2012 James Halliday resolve-from@4.0.0 @@ -2214,9 +3226,6 @@ Copyright (c) Kevin Mårtensson (github.com/kevva) shebang-regex@3.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -side-channel@1.0.4 -Copyright (c) 2019 Jordan Harband - slash@3.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -2245,15 +3254,12 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) string-width@2.1.1 Copyright (c) Sindre Sorhus (sindresorhus.com) -string.prototype.trimend@1.0.4 -Copyright (c) 2017 Khaled Al-Ansari - -string.prototype.trimstart@1.0.4 -Copyright (c) 2017 Khaled Al-Ansari - strip-ansi@6.0.1 Copyright (c) Sindre Sorhus (sindresorhus.com) +strip-bom@4.0.0 +Copyright (c) Sindre Sorhus (sindresorhus.com) + strip-json-comments@3.1.1 Copyright (c) Sindre Sorhus (https://sindresorhus.com) @@ -2263,8 +3269,11 @@ Copyright (c) Sindre Sorhus (sindresorhus.com) supports-color@7.2.0 Copyright (c) Sindre Sorhus (sindresorhus.com) -svgo@1.2.2 -Copyright © 2012–2016 Kir Belevich +supports-preserve-symlinks-flag@1.0.0 +Copyright (c) 2022 Inspect JS + +svgo@2.7.0 +Copyright (c) Kir Belevich symbol-tree@3.2.4 Copyright (c) 2015 Joris van der Wel @@ -2303,6 +3312,9 @@ tmp-promise@3.0.3 Original tmp Package: Copyright (c) 2014 KARASZI István tmp-promises Package: No Copyright +to-fast-properties@2.0.0 +Copyright (c) 2014 Petka Antonov + to-readable-stream@1.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -2335,13 +3347,13 @@ Copyright (c) 2012, Joshua Bell typedarray-to-buffer@3.1.5 Copyright (c) Feross Aboukhadijeh +uc.micro@1.0.6 +Copyright Mathias Bynens + uid-safe@2.1.5 Copyright (c) 2014 Jonathan Ong Copyright (c) 2015-2017 Douglas Christopher Wilson -unbox-primitive@1.0.1 -Copyright (c) 2019 Jordan Harband - underscore@1.13.2 Copyright (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors @@ -2354,21 +3366,18 @@ Copyright (c) 2017, Ryan Zimmerman unpipe@1.0.0 Copyright (c) 2015 Douglas Christopher Wilson -unquote@1.1.1 -Copyright (c) 2017 Cameron Lakenen - url-parse-lax@3.0.0 Copyright (c) Sindre Sorhus (sindresorhus.com) util-deprecate@1.0.2 Copyright (c) 2014 Nathan Rajlich -util.promisify@1.0.1 -Copyright (c) 2017 Jordan Harband - utils-merge@1.0.1 Copyright (c) 2013-2017 Jared Hanson +uuid@8.3.2 +Copyright (c) 2010-2020 Robert Kieffer and other contributors + v8-compile-cache@2.3.0 Copyright (c) 2019 Andres Suarez @@ -2379,7 +3388,7 @@ w3c-hr-time@1.0.2 Copyright (c) 2017 Tiancheng "Timothy" Gu and other contributors w3c-xmlserializer@3.0.0 -Copyright © Sebastian Mayr +Copyright (c) Sebastian Mayr whatwg-encoding@2.0.0 Copyright © Domenic Denicola @@ -2390,9 +3399,6 @@ Copyright © Domenic Denicola whatwg-url@10.0.0 Copyright (c) Sebastian Mayr -which-boxed-primitive@1.0.2 -Copyright (c) 2019 Jordan Harband - widest-line@3.1.0 Copyright (c) Sindre Sorhus (sindresorhus.com) @@ -2402,7 +3408,7 @@ Copyright (c) 2014-2017, Jon Schlinkert wrap-ansi@7.0.0 Copyright (c) Sindre Sorhus (https://sindresorhus.com) -ws@8.4.2 +ws@8.5.0 Copyright (c) 2011 Einar Otto Stangvik xdg-basedir@4.0.0 @@ -2418,10 +3424,7 @@ xmldom@0.5.0 Copyright 2019 - present Christopher J. Brody and other contributors, as listed in: https://github.com/xmldom/xmldom/graphs/contributors Copyright 2012 - 2017 @jindw and other contributors, as listed in: https://github.com/jindw/xmldom/graphs/contributors -yargs@17.3.0 -Copyright 2010 James Halliday (mail@substack.net); Modified work Copyright 2014 Contributors (ben@npmjs.com) - -yargs@16.2.0 +yargs@17.3.1 Copyright 2010 James Halliday (mail@substack.net); Modified work Copyright 2014 Contributors (ben@npmjs.com) yargs-unparser@2.0.0 @@ -2436,18 +3439,6 @@ Copyright (c) Sindre Sorhus (https://sindresorhus.com) zip-stream@4.1.0 Copyright (c) 2014 Chris Talkington, contributors. -#################################################################### -# Oracle elects to use the MIT license for the following packages. # -#################################################################### - -rc@1.2.8 -Copyright (c) 2011 Dominic Tarr -license specification: (BSD-2-Clause OR MIT OR Apache-2.0) - -type-fest@0.20.2 -Copyright (c) Sindre Sorhus (https:/sindresorhus.com) -license specification: (MIT OR CC0-1.0) - The MIT License @@ -2505,6 +3496,12 @@ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION The following packages are licensed under ISC License: +@istanbuljs/load-nyc-config@1.1.0 +Copyright (c) 2019, Contributors + +@trysound/sax@0.2.0 +Copyright (c) Isaac Z. Schlueter and Contributors + @ungap/promise-all-settled@1.1.2 Copyright (c) 2019, Andrea Giammarchi, @WebReflection @@ -2526,103 +3523,809 @@ Copyright (c) 2015, Ilya Radchenko cliui@7.0.4 Copyright (c) 2015, Contributors +electron-to-chromium@1.4.103 +Copyright 2018 Kilian Valkhof + fastq@1.13.0 Copyright (c) 2015-2020, Matteo Collina -flatted@3.2.4 -Copyright (c) 2018-2020, Andrea Giammarchi, @WebReflection +flatted@3.2.5 +Copyright (c) 2018-2020, Andrea Giammarchi, @WebReflection + +foreground-child@2.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +fs.realpath@1.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +get-caller-file@2.0.5 +Copyright 2018 Stefan Penner + +glob@7.2.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +glob@7.1.6 +Copyright (c) Isaac Z. Schlueter and Contributors + +glob-parent@6.0.2 +Copyright (c) 2015, 2019 Elan Shanker, 2021 Blaine Bublitz , Eric Schoffstall and other contributors + +graceful-fs@4.2.9 +Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors + +hosted-git-info@4.1.0 +Copyright (c) 2015, Rebecca Turner + +inflight@1.0.6 +Copyright (c) Isaac Z. Schlueter + +inherits@2.0.4 +Copyright (c) Isaac Z. Schlueter + +ini@1.3.8 +Copyright (c) Isaac Z. Schlueter and Contributors + +isexe@2.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +istanbul-lib-processinfo@2.0.2 +Copyright (c) Isaac Z. Schlueter and Contributors + +lru-cache@6.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +minimatch@3.0.5 +Copyright (c) Isaac Z. Schlueter and Contributors + +mute-stream@0.0.7 +Copyright (c) Isaac Z. Schlueter and Contributors + +nyc@15.1.0 +Copyright (c) 2015, Contributors + +once@1.4.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +package-hash@4.0.0 +Copyright (c) 2016-2017, Mark Wubben (novemberborn.net) + +picocolors@1.0.0 +Copyright (c) 2021 Alexey Raspopov, Kostiantyn Denysov, Anton Verinov + +release-zalgo@1.0.0 +Copyright (c) 2017, Mark Wubben (novemberborn.net) + +rimraf@3.0.2 +Copyright (c) Isaac Z. Schlueter and Contributors + +sax@1.2.4 +Copyright (c) Isaac Z. Schlueter and Contributors + +saxes@5.0.1 +Copyright (c) Contributors + +semver@6.3.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +setprototypeof@1.2.0 +Copyright (c) 2015, Wes Todd + +signal-exit@3.0.7 +Copyright (c) 2015, Contributors + +spawn-wrap@2.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +test-exclude@6.0.0 +Copyright (c) 2016, Contributors + +which@2.0.2 +Copyright (c) Isaac Z. Schlueter and Contributors + +wrappy@1.0.2 +Copyright (c) Isaac Z. Schlueter and Contributors + +write-file-atomic@3.0.3 +Copyright (c) 2015, Rebecca Turner + +y18n@5.0.8 +Copyright (c) 2015, Contributors + +yallist@4.0.0 +Copyright (c) Isaac Z. Schlueter and Contributors + +yargs-parser@20.2.4 +Copyright (c) 2016, Contributors + + +ISC License + +Permission to use, copy, modify, and/or distribute this software +for any purpose with or without fee is hereby granted, provided +that the above copyright notice and this permission notice +appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE +LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES +OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, +WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, +ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +-------------------------------------------------------------------------------- + + +The following packages are licensed under The 2-Clause BSD License, Version 2.0: + +@typescript-eslint/typescript-estree@4.9.1 +Copyright JS Foundation and other contributors, https://js.foundation + +browser-process-hrtime@1.0.0 +Copyright 2014 kumavis + +configstore@5.0.1 +Copyright (c) Google + +css-select@4.2.1 +Copyright (c) Felix Böhm + +css-what@5.0.1 +Copyright (c) Felix Böhm + +domelementtype@1.3.1 +Copyright (c) Felix Böhm + +domhandler@2.4.2 +Copyright (c) Felix Böhm + +domutils@1.7.0 +Copyright (c) Felix Böhm + +dotenv@9.0.2 +Copyright (c) 2015, Scott Motte + +dotenv-expand@5.1.0 +Copyright (c) 2016, Scott Motte + +electron-osx-sign@0.5.0 +Copyright (c) 2015-2016 Zhuo Lu, Jason Hinkle, et al. + +entities@1.1.2 +Copyright (c) Felix Böhm + +escodegen@2.0.0 +Copyright (C) 2012 Yusuke Suzuki (twitter: @Constellation) and other contributors + +eslint-scope@7.1.1 +Copyright JS Foundation and other contributors, https://js.foundation +Copyright (C) 2012-2013 Yusuke Suzuki (twitter: @Constellation) and other contributors. + +espree@9.3.1 +Copyright (c) Open JS Foundation + +espree@7.3.1 +Copyright (c) Open JS Foundation + +esprima@4.0.1 +Copyright JS Foundation and other contributors, https://js.foundation/ + +esrecurse@4.3.0 +Copyright (C) 2014 Yusuke Suzuki (twitter: @Constellation) and other contributors. + +estraverse@5.3.0 +Copyright (C) 2012-2016 Yusuke Suzuki (twitter: @Constellation) and other contributors. + +esutils@2.0.3 +Copyright (C) 2013 Yusuke Suzuki (twitter: @Constellation) and other contributors. + +extract-zip@2.0.1 +Copyright (c) 2014 Max Ogden and other contributors + +extract-zip@1.7.0 +Copyright (c) 2014 Max Ogden and other contributors + +http-cache-semantics@4.1.0 +Copyright 2016-2018 Kornel Lesiński + +nth-check@2.0.1 +Copyright (c) Felix Böhm + +terser@5.8.0 +Copyright 2012-2018 (c) Mihai Bazon + +update-notifier@5.1.0 +Copyright Google + +uri-js@4.4.1 +Copyright 2011 Gary Court. All rights reserved. + +webidl-conversions@7.0.0 +Copyright (c) 2014, Domenic Denicola + + +The 2-Clause BSD License, Version 2.0 + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. 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. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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. + +-------------------------------------------------------------------------------- + + +The following packages are licensed under The 3-Clause BSD License, Version 2.0: + +@humanwhocodes/object-schema@1.2.1 +Copyright (c) 2019, Human Who Codes + +abab@2.0.5 +Copyright © 2019 W3C and Jeff Carpenter \ + +charenc@0.0.2 +Copyright © 2011, Paul Vorbach. All rights reserved. +Copyright © 2009, Jeff Mott. All rights reserved. + +crypt@0.0.2 +Copyright © 2011, Paul Vorbach. All rights reserved. +Copyright © 2009, Jeff Mott. All rights reserved. + +diff@5.0.0 +Copyright (c) 2009-2015, Kevin Decker + +duplexer3@0.1.4 +Copyright (c) 2013, Deoxxa Development + +esquery@1.4.0 +Copyright (c) 2013, Joel Feenstra + +flat@5.0.2 +Copyright (c) 2014, Hugh Kennedy + +ieee754@1.2.1 +Copyright 2008 Fair Oaks Labs, Inc. + +istanbul-lib-coverage@3.2.0 +Copyright 2012-2015 Yahoo! Inc. + +istanbul-lib-hook@3.0.0 +Copyright 2012-2015 Yahoo! Inc. + +istanbul-lib-instrument@4.0.3 +Copyright 2012-2015 Yahoo! Inc. + +istanbul-lib-report@3.0.0 +Copyright 2012-2015 Yahoo! Inc. + +istanbul-lib-source-maps@4.0.1 +Copyright 2015 Yahoo! Inc. + +istanbul-reports@3.1.4 +Copyright 2012-2015 Yahoo! Inc. + +md5@2.3.0 +Copyright © 2011-2012, Paul Vorbach. +Copyright © 2009, Jeff Mott. + +qs@6.9.6 +Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/ljharb/qs/graphs/contributors) + +serialize-javascript@6.0.0 +Copyright 2014 Yahoo! Inc. + +source-map@0.6.1 +Copyright (c) 2009-2011, Mozilla Foundation and contributors + +tough-cookie@4.0.0 +Copyright (c) 2015, Salesforce.com, Inc. + + +The 3-Clause BSD License, Version 2.0 + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the copyright holder 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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. + +-------------------------------------------------------------------------------- + + +The following packages are licensed under Apache License, Version 2.0: + +@ampproject/remapping@2.1.2 +Copyright 2019 Google LLC + +@humanwhocodes/config-array@0.9.3 +No Copyright + +@malept/cross-spawn-promise@1.1.1 +No Copyright + +caseless@0.12.0 +No Copyright + +crc-32@1.2.1 +Copyright (C) 2014-present SheetJS LLC + +doctrine@3.0.0 +Copyright JS Foundation and other contributors, https://js.foundation + +ejs@3.1.7 +Copyright 2112 Matthew Eernisse (mde@fleegix.org) + +eslint-visitor-keys@3.3.0 +No Copyright + +eslint-visitor-keys@2.1.0 +No Copyright + +exit-on-epipe@1.0.1 +Copyright (C) 2015-present SheetJS + +filelist@1.0.3 +Copyright 2112 Matthew Eernisse (mde@fleegix.org) + +jake@10.8.5 +Copyright 2112 Matthew Eernisse (mde@fleegix.org) + +printj@1.3.1 +Copyright (C) 2016-present SheetJS LLC + +readdir-glob@1.1.1 +Copyright 2020 Yann Armelin + +rxjs@6.6.7 +Copyright (c) 2015-2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors + +sumchecker@3.0.1 +Copyright 2016, 2017, 2019, 2021 Mark Lee and contributors + +typescript@4.1.2 +Copyright (c) Microsoft Corporation. All rights reserved. + +websocket-driver@0.7.4 +Copyright 2010-2020 James Coglan + +websocket-extensions@0.1.4 +Copyright 2014-2020 James Coglan + +workerpool@6.2.0 +Copyright (C) 2014-2020 Jos de Jong wjosdejong@gmail.com + +xml-name-validator@4.0.0 +No Copyright + + +Apache License, Version 2.0 + +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by the + copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all other + entities that control, are controlled by, or are under common control with + that entity. For the purposes of this definition, "control" means (i) the + power, direct or indirect, to cause the direction or management of such + entity, whether by contract or otherwise, or (ii) ownership of fifty + percent (50%) or more of the outstanding shares, or (iii) beneficial + ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity exercising + permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation source, + and configuration files. + + "Object" form shall mean any form resulting from mechanical transformation + or translation of a Source form, including but not limited to compiled + object code, generated documentation, and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or Object form, + made available under the License, as indicated by a copyright notice that + is included in or attached to the work (an example is provided in the + Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object form, + that is based on (or derived from) the Work and for which the editorial + revisions, annotations, elaborations, or other modifications represent, + as a whole, an original work of authorship. For the purposes of this + License, Derivative Works shall not include works that remain separable + from, or merely link (or bind by name) to the interfaces of, the Work + and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including the original + version of the Work and any modifications or additions to that Work or + Derivative Works thereof, that is intentionally submitted to Licensor + for inclusion in the Work by the copyright owner or by an individual or + Legal Entity authorized to submit on behalf of the copyright owner. For + the purposes of this definition, "submitted" means any form of electronic, + verbal, or written communication sent to the Licensor or its + representatives, including but not limited to communication on electronic + mailing lists, source code control systems, and issue tracking systems + that are managed by, or on behalf of, the Licensor for the purpose of + discussing and improving the Work, but excluding communication that is + conspicuously marked or otherwise designated in writing by the copyright + owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity on + behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this + License, each Contributor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable copyright license to + reproduce, prepare Derivative Works of, publicly display, publicly + perform, sublicense, and distribute the Work and such Derivative Works + in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this + License, each Contributor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable (except as stated + in this section) patent license to make, have made, use, offer to sell, + sell, import, and otherwise transfer the Work, where such license applies + only to those patent claims licensable by such Contributor that are + necessarily infringed by their Contribution(s) alone or by combination + of their Contribution(s) with the Work to which such Contribution(s) was + submitted. If You institute patent litigation against any entity + (including a cross-claim or counterclaim in a lawsuit) alleging that the + Work or a Contribution incorporated within the Work constitutes direct or + contributory patent infringement, then any patent licenses granted to You + under this License for that Work shall terminate as of the date such + litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or + Derivative Works thereof in any medium, with or without modifications, + and in Source or Object form, provided that You meet the following conditions: + + (a) You must give any other recipients of the Work or Derivative Works a + copy of this License; and + + (b) You must cause any modified files to carry prominent notices stating + that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works that You + distribute, all copyright, patent, trademark, and attribution notices + from the Source form of the Work, excluding those notices that do not + pertain to any part of the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its distribution, + then any Derivative Works that You distribute must include a readable + copy of the attribution notices contained within such NOTICE file, + excluding those notices that do not pertain to any part of the + Derivative Works, in at least one of the following places: within a + NOTICE text file distributed as part of the Derivative Works; within + the Source form or documentation, if provided along with the Derivative + Works; or, within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents of the + NOTICE file are for informational purposes only and do not modify the + License. You may add Your own attribution notices within Derivative + Works that You distribute, alongside or as an addendum to the NOTICE + text from the Work, provided that such additional attribution notices + cannot be construed as modifying the License. + You may add Your own copyright statement to Your modifications and may + provide additional or different license terms and conditions for use, + reproduction, or distribution of Your modifications, or for any such + Derivative Works as a whole, provided Your use, reproduction, and + distribution of the Work otherwise complies with the conditions stated + in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any + Contribution intentionally submitted for inclusion in the Work by You to + the Licensor shall be under the terms and conditions of this License, + without any additional terms or conditions. Notwithstanding the above, + nothing herein shall supersede or modify the terms of any separate license + agreement you may have executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, + trademarks, service marks, or product names of the Licensor, except as + required for reasonable and customary use in describing the origin of the + Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in + writing, Licensor provides the Work (and each Contributor provides its + Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF + ANY KIND, either express or implied, including, without limitation, any + warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or + FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for + determining the appropriateness of using or redistributing the Work and + assume any risks associated with Your exercise of permissions under this + License. + +8. Limitation of Liability. In no event and under no legal theory, whether + in tort (including negligence), contract, or otherwise, unless required by + applicable law (such as deliberate and grossly negligent acts) or agreed + to in writing, shall any Contributor be liable to You for damages, + including any direct, indirect, special, incidental, or consequential + damages of any character arising as a result of this License or out of + the use or inability to use the Work (including but not limited to damages + for loss of goodwill, work stoppage, computer failure or malfunction, or + any and all other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work + or Derivative Works thereof, You may choose to offer, and charge a fee + for, acceptance of support, warranty, indemnity, or other liability + obligations and/or rights consistent with this License. However, in + accepting such obligations, You may act only on Your own behalf and on + Your sole responsibility, not on behalf of any other Contributor, and + only if You agree to indemnify, defend, and hold each Contributor harmless + for any liability incurred by, or claims asserted against, such + Contributor by reason of your accepting any such warranty or additional + liability. + +-------------------------------------------------------------------------------- + + +The following packages are licensed under Python License 2.0: + +argparse@2.0.1 +Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, + + +Python License 2.0 + +PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 + +1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and the + Individual or Organization ("Licensee") accessing and otherwise using this + software ("Python") in source or binary form and its associated documentation. + +2. Subject to the terms and conditions of this License Agreement, PSF hereby grants + Licensee a nonexclusive, royalty-free, world-wide license to reproduce, analyze, + test, perform and/or display publicly, prepare derivative works, distribute, and + otherwise use Python alone or in any derivative version, provided, however, that + PSF's License Agreement and PSF's notice of copyright, i.e., "Copyright (c) + 2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights Reserved" + are retained in Python alone or in any derivative version prepared by Licensee. + +3. In the event Licensee prepares a derivative work that is based on or incorporates + Python or any part thereof, and wants to make the derivative work available to + others as provided herein, then Licensee hereby agrees to include in any such + work a brief summary of the changes made to Python. + +4. PSF is making Python available to Licensee on an "AS IS" basis. PSF MAKES NO + REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT + LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF + MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON + WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. + +5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON FOR ANY + INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF MODIFYING, + DISTRIBUTING, OR OTHERWISE USING PYTHON, OR ANY DERIVATIVE THEREOF, EVEN IF + ADVISED OF THE POSSIBILITY THEREOF. + +6. This License Agreement will automatically terminate upon a material breach + of its terms and conditions. + +7. Nothing in this License Agreement shall be deemed to create any relationship + of agency, partnership, or joint venture between PSF and Licensee. This + License Agreement does not grant permission to use PSF trademarks or trade + name in a trademark sense to endorse or promote products or services of + Licensee, or any third party. + +8. By copying, installing or otherwise using Python, Licensee agrees to be + bound by the terms and conditions of this License Agreement. + +BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0 + +BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 + +1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office + at 160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or + Organization ("Licensee") accessing and otherwise using this software in + source or binary form and its associated documentation ("the Software"). + +2. Subject to the terms and conditions of this BeOpen Python License + Agreement, BeOpen hereby grants Licensee a non-exclusive, royalty-free, + world-wide license to reproduce, analyze, test, perform and/or display + publicly, prepare derivative works, distribute, and otherwise use the + Software alone or in any derivative version, provided, however, that + the BeOpen Python License is retained in the Software, alone or in any + derivative version prepared by Licensee. + +3. BeOpen is making the Software available to Licensee on an "AS IS" basis. + BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY + WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY + REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY + PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE + ANY THIRD PARTY RIGHTS. + +4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE + SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS + AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY + DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +5. This License Agreement will automatically terminate upon a material + breach of its terms and conditions. + +6. This License Agreement shall be governed by and interpreted in all + respects by the law of the State of California, excluding conflict + of law provisions. Nothing in this License Agreement shall be deemed + to create any relationship of agency, partnership, or joint venture + between BeOpen and Licensee. This License Agreement does not grant + permission to use BeOpen trademarks or trade names in a trademark + sense to endorse or promote products or services of Licensee, or any + third party. As an exception, the "BeOpen Python" logos available at + http://www.pythonlabs.com/logos.html may be used according to the + permissions granted on that web page. + +7. By copying, installing or otherwise using the software, Licensee + agrees to be bound by the terms and conditions of this License + Agreement. -fs.realpath@1.0.0 -Copyright (c) Isaac Z. Schlueter and Contributors +CNRI OPEN SOURCE LICENSE AGREEMENT (for Python 1.6b1) -get-caller-file@2.0.5 -Copyright 2018 Stefan Penner +IMPORTANT: PLEASE READ THE FOLLOWING AGREEMENT CAREFULLY. -glob@7.2.0 -Copyright (c) Isaac Z. Schlueter and Contributors +BY CLICKING ON "ACCEPT" WHERE INDICATED BELOW, OR BY COPYING, +INSTALLING OR OTHERWISE USING PYTHON 1.6, beta 1 SOFTWARE, YOU ARE +DEEMED TO HAVE AGREED TO THE TERMS AND CONDITIONS OF THIS LICENSE +AGREEMENT. -glob@7.1.6 -Copyright (c) Isaac Z. Schlueter and Contributors +1. This LICENSE AGREEMENT is between the Corporation for National + Research Initiatives, having an office at 1895 Preston White + Drive, Reston, VA 20191 ("CNRI"), and the Individual or + Organization ("Licensee") accessing and otherwise using Python + 1.6, beta 1 software in source or binary form and its associated + documentation, as released at the www.python.org Internet site + on August 4, 2000 ("Python 1.6b1"). -glob-parent@6.0.2 -Copyright (c) 2015, 2019 Elan Shanker, 2021 Blaine Bublitz , Eric Schoffstall and other contributors +2. Subject to the terms and conditions of this License Agreement, + CNRI hereby grants Licensee a non-exclusive, royalty-free, + world-wide license to reproduce, analyze, test, perform and/or + display publicly, prepare derivative works, distribute, and + otherwise use Python 1.6b1 alone or in any derivative version, + provided, however, that CNRIs License Agreement is retained in + Python 1.6b1, alone or in any derivative version prepared by + Licensee. -graceful-fs@4.2.8 -Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors + Alternately, in lieu of CNRIs License Agreement,Licensee may + substitute the following text (omitting the quotes): "Python + 1.6, beta 1, is made available subject to the terms and + conditions in CNRIs License Agreement. This Agreement may be + located on the Internet using the following unique, + persistent identifier (known as a handle): 1895.22/1011. + This Agreement may also be obtained from a proxy server on + the Internet using the URL:http://hdl.handle.net/1895.22/1011". -graceful-fs@4.2.9 -Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors +3. In the event Licensee prepares a derivative work that is based + on or incorporates Python 1.6b1 or any part thereof, and wants + to make the derivative work available to the public as + provided herein, then Licensee hereby agrees to indicate in + any such work the nature of the modifications made to Python + 1.6b1. -hosted-git-info@4.0.2 -Copyright (c) 2015, Rebecca Turner +4. CNRI is making Python 1.6b1 available to Licensee on an + "AS IS" basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, + EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, + CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY + OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR + THAT THE USE OF PYTHON 1.6b1 WILL NOT INFRINGE ANY THIRD + PARTY RIGHTS. -inflight@1.0.6 -Copyright (c) Isaac Z. Schlueter +5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF + THE SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL + DAMAGES OR LOSS AS A RESULT OF USING, MODIFYING OR + DISTRIBUTING PYTHON 1.6b1, OR ANY DERIVATIVE THEREOF, EVEN + IF ADVISED OF THE POSSIBILITY THEREOF. -inherits@2.0.4 -Copyright (c) Isaac Z. Schlueter +6. This License Agreement will automatically terminate upon + a material breach of its terms and conditions. -ini@1.3.8 -Copyright (c) Isaac Z. Schlueter and Contributors +7. This License Agreement shall be governed by and + interpreted in all respects by the law of the State of + Virginia, excluding conflict of law provisions. Nothing + in this License Agreement shall be deemed to create any + relationship of agency, partnership, or joint venture + between CNRI and Licensee. This License Agreement does + not grant permission to use CNRI trademarks or trade name + in a trademark sense to endorse or promote products or + services of Licensee, or any third party. -isexe@2.0.0 -Copyright (c) Isaac Z. Schlueter and Contributors +8. By clicking on the "ACCEPT" button where indicated, or by + copying, installing or otherwise using Python 1.6b1, + Licensee agrees to be bound by the terms and conditions + of this License Agreement. -lru-cache@6.0.0 -Copyright (c) Isaac Z. Schlueter and Contributors +ACCEPT -minimatch@3.0.4 -Copyright (c) Isaac Z. Schlueter and Contributors +CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 -mute-stream@0.0.7 -Copyright (c) Isaac Z. Schlueter and Contributors +Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum +Amsterdam, The Netherlands. All rights reserved. -once@1.4.0 -Copyright (c) Isaac Z. Schlueter and Contributors +Permission to use, copy, modify, and distribute this software +and its documentation for any purpose and without fee is +hereby granted, provided that the above copyright notice +appear in all copies and that both that copyright notice +and this permission notice appear in supporting +documentation, and that the name of Stichting Mathematisch +Centrum or CWI not be used in advertising or publicity +pertaining to distribution of the software without specific, +written prior permission. -rimraf@3.0.2 -Copyright (c) Isaac Z. Schlueter and Contributors +STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING +MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT OR +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING +FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF +CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -sax@1.2.4 -Copyright (c) Isaac Z. Schlueter and Contributors +-------------------------------------------------------------------------------- -saxes@5.0.1 -Copyright (c) Contributors -semver@6.3.0 -Copyright (c) Isaac Z. Schlueter and Contributors +The following packages are licensed under (WTFPL OR ISC): -setprototypeof@1.2.0 -Copyright (c) 2015, Wes Todd +sanitize-filename@1.6.3 +No Copyright -signal-exit@3.0.6 -Copyright (c) 2015, Contributors -which@2.0.2 -Copyright (c) Isaac Z. Schlueter and Contributors +Do What The F*ck You Want To Public License -wrappy@1.0.2 -Copyright (c) Isaac Z. Schlueter and Contributors +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +Version 2, December 2004 -write-file-atomic@3.0.3 -Copyright (c) 2015, Rebecca Turner +Copyright (C) 2004 Sam Hocevar -y18n@5.0.8 -Copyright (c) 2015, Contributors +Everyone is permitted to copy and distribute verbatim +or modified copies of this license document, and +changing it is allowed as long as the name is changed. -yallist@4.0.0 -Copyright (c) Isaac Z. Schlueter and Contributors +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -yargs-parser@20.2.4 -Copyright (c) 2016, Contributors + 0. You just DO WHAT THE FUCK YOU WANT TO. -#################################################################### -# Oracle elects to use the ISC license for the following packages. # -#################################################################### -sanitize-filename@1.6.3 -No Copyright -license specification: (WTFPL OR ISC) +++++++++++++++++++++ ISC License @@ -2640,172 +4343,168 @@ OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. --------------------------------------------------------------------------------- - - -The following packages are licensed under The 2-Clause BSD License, Version 2.0: - -@typescript-eslint/typescript-estree@4.9.1 -Copyright JS Foundation and other contributors, https://js.foundation - -browser-process-hrtime@1.0.0 -Copyright 2014 kumavis - -configstore@5.0.1 -Copyright (c) Google - -css-select@2.1.0 -Copyright (c) Felix Böhm - -css-what@5.0.1 -Copyright (c) Felix Böhm - -domelementtype@1.3.1 -Copyright (c) Felix Böhm - -domhandler@2.4.2 -Copyright (c) Felix Böhm - -domutils@1.7.0 -Copyright (c) Felix Böhm - -dotenv@9.0.2 -Copyright (c) 2015, Scott Motte - -dotenv-expand@5.1.0 -Copyright (c) 2016, Scott Motte - -electron-osx-sign@0.5.0 -Copyright (c) 2015-2016 Zhuo Lu, Jason Hinkle, et al. - -entities@1.1.2 -Copyright (c) Felix Böhm - -escodegen@2.0.0 -Copyright (C) 2012 Yusuke Suzuki (twitter: @Constellation) and other contributors -eslint-scope@7.1.0 -Copyright JS Foundation and other contributors, https://js.foundation -Copyright (C) 2012-2013 Yusuke Suzuki (twitter: @Constellation) and other contributors. +-------------------------------------------------------------------------------- -espree@9.2.0 -Copyright (c) Open JS Foundation -espree@7.3.1 -Copyright (c) Open JS Foundation +The following packages are licensed under (MIT OR CC0-1.0): -esprima@4.0.1 -Copyright JS Foundation and other contributors, https://js.foundation/ +type-fest@0.20.2 +Copyright (c) Sindre Sorhus (https:/sindresorhus.com) -esrecurse@4.3.0 -Copyright (C) 2014 Yusuke Suzuki (twitter: @Constellation) and other contributors. -estraverse@5.3.0 -Copyright (C) 2012-2016 Yusuke Suzuki (twitter: @Constellation) and other contributors. +The MIT License -esutils@2.0.3 -Copyright (C) 2013 Yusuke Suzuki (twitter: @Constellation) and other contributors. +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -extract-zip@2.0.1 -Copyright (c) 2014 Max Ogden and other contributors +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. -extract-zip@1.7.0 -Copyright (c) 2014 Max Ogden and other contributors +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. -http-cache-semantics@4.1.0 -Copyright 2016-2018 Kornel Lesiński -nth-check@1.0.2 -Copyright (c) Felix Böhm +++++++++++++++++++++ -terser@4.8.0 -Copyright 2012-2018 (c) Mihai Bazon -update-notifier@5.1.0 -Copyright Google +CC0 1.0 Universal Public Domain Dedication -uri-js@4.4.1 -Copyright 2011 Gary Court. All rights reserved. +Statement of Purpose -webidl-conversions@7.0.0 -Copyright (c) 2014, Domenic Denicola +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. -The 2-Clause BSD License, Version 2.0 +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: +1. Copyright and Related Rights. A Work made available under CC0 may be + protected by copyright and related or neighboring rights ("Copyright and + Related Rights"). Copyright and Related Rights include, but are not limited + to, the following: -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; -2. 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. + ii. moral rights retained by the original author(s) and/or performer(s); -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 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. + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; --------------------------------------------------------------------------------- + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; -The following packages are licensed under The 3-Clause BSD License, Version 2.0: + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and -@humanwhocodes/object-schema@1.2.1 -Copyright (c) 2019, Human Who Codes + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. -abab@2.0.5 -Copyright © 2019 W3C and Jeff Carpenter \ +2. Waiver. To the greatest extent permitted by, but not in contravention of, + applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and + unconditionally waives, abandons, and surrenders all of Affirmer's Copyright + and Related Rights and associated claims and causes of action, whether now + known or unknown (including existing as well as future claims and causes of + action), in the Work (i) in all territories worldwide, (ii) for the maximum + duration provided by applicable law or treaty (including future time + extensions), (iii) in any current or future medium and for any number of + copies, and (iv) for any purpose whatsoever, including without limitation + commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes + the Waiver for the benefit of each member of the public at large and to the + detriment of Affirmer's heirs and successors, fully intending that such Waiver + shall not be subject to revocation, rescission, cancellation, termination, or + any other legal or equitable action to disrupt the quiet enjoyment of the Work + by the public as contemplated by Affirmer's express Statement of Purpose. -charenc@0.0.2 -Copyright © 2011, Paul Vorbach. All rights reserved. -Copyright © 2009, Jeff Mott. All rights reserved. +3. Public License Fallback. Should any part of the Waiver for any reason be + judged legally invalid or ineffective under applicable law, then the Waiver + shall be preserved to the maximum extent permitted taking into account + Affirmer's express Statement of Purpose. In addition, to the extent the Waiver + is so judged Affirmer hereby grants to each affected person a royalty-free, + non transferable, non sublicensable, non exclusive, irrevocable and + unconditional license to exercise Affirmer's Copyright and Related Rights in + the Work (i) in all territories worldwide, (ii) for the maximum duration + provided by applicable law or treaty (including future time extensions), (iii) + in any current or future medium and for any number of copies, and (iv) for any + purpose whatsoever, including without limitation commercial, advertising or + promotional purposes (the "License"). The License shall be deemed effective as + of the date CC0 was applied by Affirmer to the Work. Should any part of the + License for any reason be judged legally invalid or ineffective under + applicable law, such partial invalidity or ineffectiveness shall not + invalidate the remainder of the License, and in such case Affirmer hereby + affirms that he or she will not (i) exercise any of his or her remaining + Copyright and Related Rights in the Work or (ii) assert any associated claims + and causes of action with respect to the Work, in either case contrary to + Affirmer's express Statement of Purpose. -crypt@0.0.2 -Copyright © 2011, Paul Vorbach. All rights reserved. -Copyright © 2009, Jeff Mott. All rights reserved. +4. Limitations and Disclaimers. -diff@5.0.0 -Copyright (c) 2009-2015, Kevin Decker + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. -duplexer3@0.1.4 -Copyright (c) 2013, Deoxxa Development + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. -esquery@1.4.0 -Copyright (c) 2013, Joel Feenstra + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. -flat@5.0.2 -Copyright (c) 2014, Hugh Kennedy + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. -ieee754@1.2.1 -Copyright 2008 Fair Oaks Labs, Inc. +For more information, please see + -md5@2.3.0 -Copyright © 2011-2012, Paul Vorbach. -Copyright © 2009, Jeff Mott. -qs@6.9.6 -Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/ljharb/qs/graphs/contributors) +-------------------------------------------------------------------------------- -serialize-javascript@6.0.0 -Copyright 2014 Yahoo! Inc. -source-map@0.6.1 -Copyright (c) 2009-2011, Mozilla Foundation and contributors +The following packages are licensed under (BSD-2-Clause OR MIT OR Apache-2.0): -tough-cookie@4.0.0 -Copyright (c) 2015, Salesforce.com, Inc. +rc@1.2.8 +Copyright (c) 2011 Dominic Tarr -The 3-Clause BSD License, Version 2.0 +The 2-Clause BSD License, Version 2.0 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -2817,10 +4516,6 @@ are permitted provided that the following conditions are met: list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -3. Neither the name of the copyright holder 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -2832,70 +4527,32 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWIS ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --------------------------------------------------------------------------------- - - -The following packages are licensed under Apache License, Version 2.0: - -@humanwhocodes/config-array@0.9.2 -No Copyright - -@malept/cross-spawn-promise@1.1.1 -No Copyright - -caseless@0.12.0 -No Copyright - -crc-32@1.2.0 -Copyright (C) 2014-present SheetJS - -doctrine@3.0.0 -Copyright JS Foundation and other contributors, https://js.foundation - -ejs@3.1.6 -Copyright 2112 Matthew Eernisse (mde@fleegix.org) - -eslint-visitor-keys@3.1.0 -No Copyright - -eslint-visitor-keys@2.1.0 -No Copyright - -exit-on-epipe@1.0.1 -Copyright (C) 2015-present SheetJS - -filelist@1.0.2 -Copyright 2112 Matthew Eernisse (mde@fleegix.org) -jake@10.8.2 -Copyright 2112 Matthew Eernisse (mde@fleegix.org) - -printj@1.1.2 -Copyright (C) 2016-present SheetJS - -readdir-glob@1.1.1 -Copyright 2020 Yann Armelin +++++++++++++++++++++ -rxjs@6.6.7 -Copyright (c) 2015-2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors -sumchecker@3.0.1 -Copyright 2016, 2017, 2019, 2021 Mark Lee and contributors +The MIT License -typescript@4.1.2 -Copyright (c) Microsoft Corporation. All rights reserved. +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -websocket-driver@0.7.4 -Copyright 2010-2020 James Coglan +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. -websocket-extensions@0.1.4 -Copyright 2014-2020 James Coglan +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. -workerpool@6.1.5 -Copyright (C) 2014-2020 Jos de Jong wjosdejong@gmail.com -xml-name-validator@4.0.0 -No Copyright +++++++++++++++++++++ Apache License, Version 2.0 @@ -3065,205 +4722,439 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION Contributor by reason of your accepting any such warranty or additional liability. --------------------------------------------------------------------------------- - - -The following packages are licensed under Python License 2.0: - -argparse@2.0.1 -Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, - - -Python License 2.0 - -PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 - -1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and the - Individual or Organization ("Licensee") accessing and otherwise using this - software ("Python") in source or binary form and its associated documentation. - -2. Subject to the terms and conditions of this License Agreement, PSF hereby grants - Licensee a nonexclusive, royalty-free, world-wide license to reproduce, analyze, - test, perform and/or display publicly, prepare derivative works, distribute, and - otherwise use Python alone or in any derivative version, provided, however, that - PSF's License Agreement and PSF's notice of copyright, i.e., "Copyright (c) - 2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights Reserved" - are retained in Python alone or in any derivative version prepared by Licensee. - -3. In the event Licensee prepares a derivative work that is based on or incorporates - Python or any part thereof, and wants to make the derivative work available to - others as provided herein, then Licensee hereby agrees to include in any such - work a brief summary of the changes made to Python. - -4. PSF is making Python available to Licensee on an "AS IS" basis. PSF MAKES NO - REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT - LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF - MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON - WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. - -5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON FOR ANY - INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF MODIFYING, - DISTRIBUTING, OR OTHERWISE USING PYTHON, OR ANY DERIVATIVE THEREOF, EVEN IF - ADVISED OF THE POSSIBILITY THEREOF. -6. This License Agreement will automatically terminate upon a material breach - of its terms and conditions. +-------------------------------------------------------------------------------- -7. Nothing in this License Agreement shall be deemed to create any relationship - of agency, partnership, or joint venture between PSF and Licensee. This - License Agreement does not grant permission to use PSF trademarks or trade - name in a trademark sense to endorse or promote products or services of - Licensee, or any third party. -8. By copying, installing or otherwise using Python, Licensee agrees to be - bound by the terms and conditions of this License Agreement. +The following packages are licensed under Creative Commons Attribution 4.0 International Public License: -BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0 +caniuse-lite@1.0.30001323 +No Copyright -BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 -1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office - at 160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or - Organization ("Licensee") accessing and otherwise using this software in - source or binary form and its associated documentation ("the Software"). +Creative Commons Attribution 4.0 International Public License + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways +otherwise restricted by copyright and certain other rights. Our licenses are +irrevocable. Licensors should read and understand the terms and conditions of +the license they choose before applying it. Licensors should also secure all +rights necessary before applying our licenses so that the public can reuse the +material as expected. Licensors should clearly mark any material not subject +to the license. This includes other CC-licensed material, or material used +under an exception or limitation to copyright. More considerations for +licensors: wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a +licensor grants the public permission to use the licensed material under +specified terms and conditions. If the licensor's permission is not necessary +for any reason--for example, because of any applicable exception or limitation +to copyright--then that use is not regulated by the license. Our licenses +grant only permissions under copyright and certain other rights that a +licensor has authority to grant. Use of the licensed material may still be +restricted for other reasons, including because others have copyright or other +rights in the material. A licensor may make special requests, such as asking +that all changes be marked or described. Although not required by our +licenses, you are encouraged to respect those requests where reasonable. +More_considerations for the public: +wiki.creativecommons.org/Considerations_for_licensees + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be +bound by the terms and conditions of this Creative Commons Attribution 4.0 +International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights + that is derived from or based upon the Licensed Material and in which the + Licensed Material is translated, altered, arranged, transformed, or + otherwise modified in a manner requiring permission under the Copyright + and Similar Rights held by the Licensor. For purposes of this Public + License, where the Licensed Material is a musical work, performance, or + sound recording, Adapted Material is always produced where the Licensed + Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and + Similar Rights in Your contributions to Adapted Material in accordance + with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, performance, + broadcast, sound recording, and Sui Generis Database Rights, without + regard to how the rights are labeled or categorized. For purposes of this + Public License, the rights specified in Section 2(b)(1)-(2) are not + Copyright and Similar Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright Treaty + adopted on December 20, 1996, and/or similar international agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or any other + exception or limitation to Copyright and Similar Rights that applies to + Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, or other + material to which the Licensor applied this Public License. + + g. Licensed Rights means the rights granted to You subject to the terms and + conditions of this Public License, which are limited to all Copyright and + Similar Rights that apply to Your use of the Licensed Material and that + the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights under + this Public License. + + i. Share means to provide material to the public by any means or process + that requires permission under the Licensed Rights, such as reproduction, + public display, public performance, distribution, dissemination, + communication, or importation, and to make material available to the + public including in ways that members of the public may access the + material from a place and at a time individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright resulting + from Directive 96/9/EC of the European Parliament and of the Council of + 11 March 1996 on the legal protection of databases, as amended and/or + succeeded, as well as other essentially equivalent rights anywhere in the + world. + + k. You means the individual or entity exercising the Licensed Rights under + this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the + Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to exercise the + Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public License does + not apply, and You do not need to comply with its terms and + conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor + authorizes You to exercise the Licensed Rights in all media and + formats whether now known or hereafter created, and to make technical + modifications necessary to do so. The Licensor waives and/or agrees + not to assert any right or authority to forbid You from making + technical modifications necessary to exercise the Licensed Rights, + including technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, simply + making modifications authorized by this Section 2(a)(4) never produces + Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the + Licensed Material automatically receives an offer from the Licensor + to exercise the Licensed Rights under the terms and conditions of + this Public License. + B. No downstream restrictions. You may not offer or impose any + additional or different terms or conditions on, or apply any + Effective Technological Measures to, the Licensed Material if doing + so restricts exercise of the Licensed Rights by any recipient of + the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be + construed as permission to assert or imply that You are, or that Your + use of the Licensed Material is, connected with, or sponsored, + endorsed, or granted official status by, the Licensor or others + designated to receive attribution as provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under + this Public License, nor are publicity, privacy, and/or other similar + personality rights; however, to the extent possible, the Licensor + waives and/or agrees not to assert any such rights held by the + Licensor to the limited extent necessary to allow You to exercise the + Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect + royalties from You for the exercise of the Licensed Rights, whether + directly or through a collecting society under any voluntary or + waivable statutory or compulsory licensing scheme. In all other cases + the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), + You must: + + A. retain the following if it is supplied by the Licensor with + the Licensed Material: + i. identification of the creator(s) of the Licensed Material and + any others designated to receive attribution, in any reasonable + manner requested by the Licensor (including by pseudonym if + designated); + ii. a copyright notice; + iii. a notice that refers to this Public License; + iv. a notice that refers to the disclaimer of warranties; + v. a URI or hyperlink to the Licensed Material to the extent + reasonably practicable; + B. indicate if You modified the Licensed Material and retain an + indication of any previous modifications; and + C. indicate the Licensed Material is licensed under this Public + License, and include the text of, or the URI or hyperlink to, + this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable + manner based on the medium, means, and context in which You Share the + Licensed Material. For example, it may be reasonable to satisfy the + conditions by providing a URI or hyperlink to a resource that includes + the required information. + + 3. If requested by the Licensor, You must remove any of the information + required by Section 3(a)(1)(A) to the extent reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You + apply must not prevent recipients of the Adapted Material from + complying with this Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to + extract, reuse, reproduce, and Share all or a substantial portion of the + contents of the database; + + b. if You include all or a substantial portion of the database contents in a + database in which You have Sui Generis Database Rights, then the database + in which You have Sui Generis Database Rights (but not its individual + contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share all or a + substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent + possible, the Licensor offers the Licensed Material as-is and + as-available, and makes no representations or warranties of any kind + concerning the Licensed Material, whether express, implied, statutory, or + other. This includes, without limitation, warranties of title, + merchantability, fitness for a particular purpose, non-infringement, + absence of latent or other defects, accuracy, or the presence or absence + of errors, whether or not known or discoverable. Where disclaimers of + warranties are not allowed in full or in part, this disclaimer may not + apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on + any legal theory (including, without limitation, negligence) or otherwise + for any direct, special, indirect, incidental, consequential, punitive, + exemplary, or other losses, costs, expenses, or damages arising out of + this Public License or use of the Licensed Material, even if the Licensor + has been advised of the possibility of such losses, costs, expenses, or + damages. Where a limitation of liability is not allowed in full or in + part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above + shall be interpreted in a manner that, to the extent possible, most + closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar + Rights licensed here. However, if You fail to comply with this Public + License, then Your rights under this Public License terminate + automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is + cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right + the Licensor may have to seek remedies for Your violations of this Public + License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed + Material under separate terms or conditions or stop distributing the + Licensed Material at any time; however, doing so will not terminate this + Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or + conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed + Material not stated herein are separate from and independent of the terms + and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not + be interpreted to, reduce, limit, restrict, or impose conditions on any + use of the Licensed Material that could lawfully be made without + permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed + unenforceable, it shall be automatically reformed to the minimum extent + necessary to make it enforceable. If the provision cannot be reformed, it + shall be severed from this Public License without affecting the + enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure + to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a + limitation upon, or waiver of, any privileges and immunities that apply + to the Licensor or You, including from the legal processes of any + jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, +Creative Commons may elect to apply one of its public licenses to material +it publishes and in those instances will be considered the "Licensor." The +text of the Creative Commons public licenses is dedicated to the public +domain under the CC0 Public Domain Dedication. Except for the limited purpose +of indicating that material is shared under a Creative Commons public license +or as otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the use of +the trademark "Creative Commons" or any other trademark or logo of Creative +Commons without its prior written consent including, without limitation, in +connection with any unauthorized modifications to any of its public licenses +or any other arrangements, understandings, or agreements concerning use of +licensed material. For the avoidance of doubt, this paragraph does not form +part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. -2. Subject to the terms and conditions of this BeOpen Python License - Agreement, BeOpen hereby grants Licensee a non-exclusive, royalty-free, - world-wide license to reproduce, analyze, test, perform and/or display - publicly, prepare derivative works, distribute, and otherwise use the - Software alone or in any derivative version, provided, however, that - the BeOpen Python License is retained in the Software, alone or in any - derivative version prepared by Licensee. +-------------------------------------------------------------------------------- -3. BeOpen is making the Software available to Licensee on an "AS IS" basis. - BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY - WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY - REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY - PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE - ANY THIRD PARTY RIGHTS. -4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE - SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS - AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY - DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. +The following packages are licensed under The Universal Permissive License (UPL), Version 1.0: -5. This License Agreement will automatically terminate upon a material - breach of its terms and conditions. +@oracle/ojet-cli@12.1.0 +Copyright (c) 2022 Oracle and/or its affiliates. -6. This License Agreement shall be governed by and interpreted in all - respects by the law of the State of California, excluding conflict - of law provisions. Nothing in this License Agreement shall be deemed - to create any relationship of agency, partnership, or joint venture - between BeOpen and Licensee. This License Agreement does not grant - permission to use BeOpen trademarks or trade names in a trademark - sense to endorse or promote products or services of Licensee, or any - third party. As an exception, the "BeOpen Python" logos available at - http://www.pythonlabs.com/logos.html may be used according to the - permissions granted on that web page. +@oracle/oraclejet-audit@12.1.0 +Copyright (c) 2019, 2022 Oracle and/or its affiliates -7. By copying, installing or otherwise using the software, Licensee - agrees to be bound by the terms and conditions of this License - Agreement. +@oracle/oraclejet-tooling@12.1.1 +Copyright (c) 2022 Oracle and/or its affiliates. -CNRI OPEN SOURCE LICENSE AGREEMENT (for Python 1.6b1) -IMPORTANT: PLEASE READ THE FOLLOWING AGREEMENT CAREFULLY. +The Universal Permissive License (UPL), Version 1.0 -BY CLICKING ON "ACCEPT" WHERE INDICATED BELOW, OR BY COPYING, -INSTALLING OR OTHERWISE USING PYTHON 1.6, beta 1 SOFTWARE, YOU ARE -DEEMED TO HAVE AGREED TO THE TERMS AND CONDITIONS OF THIS LICENSE -AGREEMENT. +Subject to the condition set forth below, permission is +hereby granted to any person obtaining a copy of this +software, associated documentation and/or data +(collectively the "Software"), free of charge and under +any and all copyright rights in the Software, and any +and all patent rights owned or freely licensable by +each licensor hereunder covering either (i) the +unmodified Software as contributed to or provided by +such licensor, or (ii) the Larger Works (as defined +below), to deal in both -1. This LICENSE AGREEMENT is between the Corporation for National - Research Initiatives, having an office at 1895 Preston White - Drive, Reston, VA 20191 ("CNRI"), and the Individual or - Organization ("Licensee") accessing and otherwise using Python - 1.6, beta 1 software in source or binary form and its associated - documentation, as released at the www.python.org Internet site - on August 4, 2000 ("Python 1.6b1"). + (a) the Software, and -2. Subject to the terms and conditions of this License Agreement, - CNRI hereby grants Licensee a non-exclusive, royalty-free, - world-wide license to reproduce, analyze, test, perform and/or - display publicly, prepare derivative works, distribute, and - otherwise use Python 1.6b1 alone or in any derivative version, - provided, however, that CNRIs License Agreement is retained in - Python 1.6b1, alone or in any derivative version prepared by - Licensee. + (b) any piece of software and/or hardware listed + in the lrgrwrks.txt file if one is included + with the Software (each a "Larger Work" to + which the Software is contributed by such + licensors), - Alternately, in lieu of CNRIs License Agreement,Licensee may - substitute the following text (omitting the quotes): "Python - 1.6, beta 1, is made available subject to the terms and - conditions in CNRIs License Agreement. This Agreement may be - located on the Internet using the following unique, - persistent identifier (known as a handle): 1895.22/1011. - This Agreement may also be obtained from a proxy server on - the Internet using the URL:http://hdl.handle.net/1895.22/1011". +without restriction, including without limitation +the rights to copy, create derivative works of, +display, perform, and distribute the Software and +make, use, sell, offer for sale, import, export, +have made, and have sold the Software and the Larger +Work(s), and to sublicense the foregoing rights on +either these or other terms. -3. In the event Licensee prepares a derivative work that is based - on or incorporates Python 1.6b1 or any part thereof, and wants - to make the derivative work available to the public as - provided herein, then Licensee hereby agrees to indicate in - any such work the nature of the modifications made to Python - 1.6b1. +This license is subject to the following condition: -4. CNRI is making Python 1.6b1 available to Licensee on an - "AS IS" basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, - EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, - CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY - OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR - THAT THE USE OF PYTHON 1.6b1 WILL NOT INFRINGE ANY THIRD - PARTY RIGHTS. +The above copyright notice and either this complete +permission notice or at a minimum a reference to the +UPL must be included in all copies or substantial +portions of the Software. -5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF - THE SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL - DAMAGES OR LOSS AS A RESULT OF USING, MODIFYING OR - DISTRIBUTING PYTHON 1.6b1, OR ANY DERIVATIVE THEREOF, EVEN - IF ADVISED OF THE POSSIBILITY THEREOF. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY +OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES +OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. -6. This License Agreement will automatically terminate upon - a material breach of its terms and conditions. +-------------------------------------------------------------------------------- -7. This License Agreement shall be governed by and - interpreted in all respects by the law of the State of - Virginia, excluding conflict of law provisions. Nothing - in this License Agreement shall be deemed to create any - relationship of agency, partnership, or joint venture - between CNRI and Licensee. This License Agreement does - not grant permission to use CNRI trademarks or trade name - in a trademark sense to endorse or promote products or - services of Licensee, or any third party. -8. By clicking on the "ACCEPT" button where indicated, or by - copying, installing or otherwise using Python 1.6b1, - Licensee agrees to be bound by the terms and conditions - of this License Agreement. +The following packages are licensed under BSD Zero Clause License: -ACCEPT +tslib@1.14.1 +Copyright (c) Microsoft Corporation. -CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 -Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum -Amsterdam, The Netherlands. All rights reserved. +BSD Zero Clause License -Permission to use, copy, modify, and distribute this software -and its documentation for any purpose and without fee is -hereby granted, provided that the above copyright notice -appear in all copies and that both that copyright notice -and this permission notice appear in supporting -documentation, and that the name of Stichting Mathematisch -Centrum or CWI not be used in advertising or publicity -pertaining to distribution of the software without specific, -written prior permission. +Permission to use, copy, modify, and/or distribute this software +for any purpose with or without fee is hereby granted. -STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH -REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING -MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT OR -CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING -FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF -CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT -OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -------------------------------------------------------------------------------- @@ -3394,90 +5285,6 @@ For more information, please see -------------------------------------------------------------------------------- -The following packages are licensed under The Universal Permissive License (UPL), Version 1.0: - -@oracle/ojet-cli@11.1.0 -Copyright (c) 2021 Oracle and/or its affiliates. - -@oracle/oraclejet-audit@11.1.3 -Copyright (c) 2019, 2021 Oracle and/or its affiliates - -@oracle/oraclejet-tooling@11.1.1 -Copyright (c) 2021 Oracle and/or its affiliates. - - -The Universal Permissive License (UPL), Version 1.0 - -Subject to the condition set forth below, permission is -hereby granted to any person obtaining a copy of this -software, associated documentation and/or data -(collectively the "Software"), free of charge and under -any and all copyright rights in the Software, and any -and all patent rights owned or freely licensable by -each licensor hereunder covering either (i) the -unmodified Software as contributed to or provided by -such licensor, or (ii) the Larger Works (as defined -below), to deal in both - - (a) the Software, and - - (b) any piece of software and/or hardware listed - in the lrgrwrks.txt file if one is included - with the Software (each a "Larger Work" to - which the Software is contributed by such - licensors), - -without restriction, including without limitation -the rights to copy, create derivative works of, -display, perform, and distribute the Software and -make, use, sell, offer for sale, import, export, -have made, and have sold the Software and the Larger -Work(s), and to sublicense the foregoing rights on -either these or other terms. - -This license is subject to the following condition: - -The above copyright notice and either this complete -permission notice or at a minimum a reference to the -UPL must be included in all copies or substantial -portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY -OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT -LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES -OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. - --------------------------------------------------------------------------------- - - -The following packages are licensed under BSD Zero Clause License: - -tslib@1.14.1 -Copyright (c) Microsoft Corporation. - - -BSD Zero Clause License - -Permission to use, copy, modify, and/or distribute this software -for any purpose with or without fee is hereby granted. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - --------------------------------------------------------------------------------- - - parse-cache-control@1.0.1 Copyright (c) 2012-2014, Walmart and other contributors. diff --git a/documentation/1.1/themes/learn/exampleSite/content/basics/configuration/_index.fr.md b/documentation/1.1/themes/learn/exampleSite/content/basics/configuration/_index.fr.md index 72e496da7..7f618e48f 100644 --- a/documentation/1.1/themes/learn/exampleSite/content/basics/configuration/_index.fr.md +++ b/documentation/1.1/themes/learn/exampleSite/content/basics/configuration/_index.fr.md @@ -72,7 +72,6 @@ Les paramètres de configuration du mermaid peuvent également être définis su > À la page "Architecture", vous avez besoin d'un diagramme de classe. Vous pouvez régler les paramètres de mermaid localement pour ne charger que la sirène sur cette page (pas sur les autres). Vous pouvez également désactiver mermaid pour des pages spécifiques tout en l'activant globalement. -<<<<<<< HEAD ## Configuration du bouton Accueil @@ -106,5 +105,3 @@ landingPageName = " Home" Le bouton d'accueil va ressembler à ceci: ![Default Home Button](/en/basics/configuration/images/home_button_defaults.jpg?width=100%) -======= ->>>>>>> 023fe7ef2b4c45fe66ac932d9e25d09f30b74a4e diff --git a/documentation/staging/1.2/.gitkeep b/documentation/staging/1.2/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/documentation/staging/1.2/archetypes/default.md b/documentation/staging/1.2/archetypes/default.md new file mode 100644 index 000000000..5ae3c0131 --- /dev/null +++ b/documentation/staging/1.2/archetypes/default.md @@ -0,0 +1,6 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +draft: false +--- + diff --git a/documentation/staging/1.2/config.toml b/documentation/staging/1.2/config.toml new file mode 100644 index 000000000..2533e829e --- /dev/null +++ b/documentation/staging/1.2/config.toml @@ -0,0 +1,20 @@ +# analytics +googleAnalytics = "UA-129126578-2" + +baseURL = '/weblogic-toolikit-ui' +languageCode = 'en-us' +title = 'WebLogic Kubernetes Toolkit UI' + +# Change the default theme to be use when building the site with Hugo +theme = 'learn' + +publishDir = "docs" + +# For search functionality +[outputs] + home = [ "HTML", "RSS", "JSON"] + +[params] + # disable the copy to clipboard links + disableInlineCopyToClipBoard = true + custom_css = [ "css/theme-wktui.css" ] diff --git a/documentation/staging/1.2/content/_index.md b/documentation/staging/1.2/content/_index.md new file mode 100644 index 000000000..c188ae826 --- /dev/null +++ b/documentation/staging/1.2/content/_index.md @@ -0,0 +1,48 @@ +## WebLogic Kubernetes Toolkit UI Documentation + +The WebLogic Kubernetes Toolkit (WKT) is a collection of open source tools that help you provision WebLogic-based +applications to run in Linux containers on a Kubernetes cluster. WKT includes the following tools: + +- [WebLogic Deploy Tooling (WDT)](https://github.com/oracle/weblogic-deploy-tooling) - A set of single-purpose, + lifecycle tools that operate off of a single metadata model representation of a WebLogic domain. +- [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool) - A tool for creating Linux container + images for running WebLogic domains. +- [WebLogic Kubernetes Operator (WKO)](https://github.com/oracle/weblogic-kubernetes-operator) - A Kubernetes operator + that allows WebLogic domains to run natively in a Kubernetes cluster. + +The WKT UI provides a graphical user interface that wraps the WKT tools, Docker, Helm, and the Kubernetes client +(`kubectl`) and helps guide you through the process of creating and modifying a model of your WebLogic domain, creating +a Linux container image to use to run the domain, and setting up and deploying the software and configuration +necessary to deploy and access the domain in your Kubernetes cluster. + +### Current release + +WebLogic Kubernetes Toolkit UI version and release information can be found [here](https://github.com/oracle/weblogic-toolkit-ui/releases). + +### About the Documentation +For detailed user information, read the following: + +- [About the WKT UI Application]({{< relref "/concepts/_index.md" >}}) +- WebLogic Kubernetes Toolkit UI [Prerequisites]({{< relref "/setup/prerequisites.md" >}}) and [Installation]({{< relref "/setup/install.md" >}}) +- [Navigate the WKT UI]({{< relref "/navigate/_index.md" >}}) + - [Model]({{< relref "/navigate/model.md" >}}) + - [Image]({{< relref "/navigate/image.md" >}}) + - [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}}) + - [Verrazzano]({{< relref "/navigate/verrazzano.md" >}}) + +For developer information, see [WebLogic Kubernetes Toolkit UI Project]({{< relref "/developer/_index.md" >}}). + +### Get Help + +We have a closely monitored public Slack channel where you can get in touch with us to ask questions about using the +WebLogic Toolkit UI or give us feedback or suggestions about what features and improvements you would like to see. +We would love to hear from you. + +To join our public channel, please visit this [site](https://weblogic-slack-inviter.herokuapp.com/) to get an invitation. The invitation email will include details of how to access our Slack workspace. After you are logged in, please come to `#weblogic-kubernetes-toolkit` and say, “hello!” + +### Related Projects +For detailed documentation and access to WebLogic Toolkit-related projects, see: + +- [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) +- [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) +- [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) diff --git a/documentation/staging/1.2/content/concepts/_index.md b/documentation/staging/1.2/content/concepts/_index.md new file mode 100644 index 000000000..9df614853 --- /dev/null +++ b/documentation/staging/1.2/content/concepts/_index.md @@ -0,0 +1,154 @@ ++++ +title = "About the WKT UI Application" +date = 2019-02-22T15:27:38-05:00 +weight = 1 +pre = " " ++++ + + + +### Contents + +- [WKT Project File](#wkt-project-file) +- [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file) + - [Environment Variables](#environment-variables) + - [User Preferences](#user-preferences) + - [Proxy Configuration](#proxy-configuration) + - [Logging Configuration](#logging-configuration) + - [WebLogic Kubernetes Toolkit UI Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration) + - [External Applications](#external-applications) + - [Bundled WKT Applications](#bundled-wkt-applications) + + + +Before giving you the whirlwind tour of the WKT UI application, it is important to know that the application is a native, +desktop application. It uses native operating system features, such as: + +- Native menus - Some of the application's functionality is available _only_ by using the menus. +- Registering file extensions - The application installer registers the `.wktproj` extension and associates itself + with that extension. For example, this lets you double-click on the file in the native file browser and + have the application start and open the selected project. +- Recent files integration - As you work with `.wktproj` files, the application adds those files to the OS-maintained + list of recently used files. This causes these files to show up in OS-specific locations to provide shortcuts for + opening the file with the application. For example, on macOS, right-clicking on the application icon in the dock will + display the recently used `.wktproj` files and selecting one will open an application window and load the contents + of the `.wktproj` file. + +### WKT Project File +What is a `.wktproj` file? Simply put, it is the application's equivalent of an Integrated Development Environment +(IDE) project file. It stores: + +- Metadata about the UI project. +- Pointers to WDT model-related files used by the project. +- Form field data that you enter into the application. + +There are two ways to create a new project: +- Explicitly - Use `File` > `New Project` and select the file location and name. +- Implicitly - Use the application to start working. After you trigger an action that needs a project file, you are + prompted to select the file location and name. + +_Note that the file extension for project files must be `.wktproj`. Otherwise, the application will not recognize the +file as a project and will not allow it to be opened as a project file._ + +The WKT UI application uses a one project per window paradigm and most everything you do in the window is +affected by the project data, either stored directly in the project file or in the WDT model-related files referenced +by the project. However, there are a few exceptions that are covered in [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file). + +### Settings Outside the WKT Project File + +Multiple factors influence the behavior of the WKT UI application in a particular environment. Other than the WKT Project file, +those include: + +- [Environment Variables](#environment-variables) - The application uses the environment it inherits when it is started. +- [User Preferences](#user-preferences) - The application's user preferences file stores shared, user-level settings that + transcend project boundaries. +- [External Applications](#external-applications) - The application or its components depend on an application being available and properly configured. +- [Bundled WKT Applications](#bundled-wkt-applications) - The application bundles its own copies of WebLogic Deploy Tooling and WebLogic Image Tool. + +#### Environment Variables +Some of the application's behavior is influenced by environment variables it inherits when it is started. Environment +variables affect the behavior of the WKT UI application when computing default values for application form fields. Some +examples are: + +- `PATH` - Used to locate executables like `docker`, `helm`, and `kubectl`. +- `JAVA_HOME` - Used as one way to find the directory where the Java Development Kit (JDK) is installed. +- `ORACLE_HOME` and `MW_HOME` - Used to find the Oracle Fusion Middleware installation directory. + +{{% notice note %}} +On Windows and Linux platforms, this tends to be the user's environment that they have configured to be used when +they log in. On macOS, native applications do not inherit the user's login environment. Instead, the application +inherits the environment configured by the `launchd` daemon process. If you are running on macOS, then you should keep this in mind +when the application doesn't behave as you expect. For more information, see [Project Settings]({{< relref "/navigate/project-settings.md" >}}). +{{% /notice %}} + +#### User Preferences + +The `Preferences` menu lets you configure settings that affect the behavior of the WKT UI application for the user +across all instances of the application on the machine. These user-visible settings include the following categories: + +- [Proxy Configuration](#proxy-configuration) +- [Logging Configuration](#logging-configuration) +- WebLogic Kubernetes Toolkit UI [Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration) + +Settings are also used to store internally used values that impact the appearance of the application. For example, the +Window size is stored so that the application will open the window with your last known window size. The list of +such appearance-related settings will likely grow over time. + +##### Proxy Configuration + +If the WKT UI application is to be run from an environment where a proxy server is required to access the Internet, then you +must configure the proxy server settings to allow Internet access. Currently, the UI depends on access to +`github.com` to access release information and download new releases of the WKT tools and the UI itself. This connectivity +is used in various places to determine default values for input data (for example, the default image tag to use for installing the +WebLogic Kubernetes Operator) and providing updated features for the WKT tools bundled with the application, as +well as updating the WKT UI application itself when a new release becomes available. Depending on the project configuration, +the application may also require access to other sites, such as Docker Hub and other container registries, Helm chart +download sites, and cloud-provider sites for authenticating to and accessing remote Kubernetes clusters. + +To configure the proxy environment, use the `Preferences` menu to add or update the +following fields, as needed: + +- `HTTPS Proxy URL` - The full URL to the proxy server (for example, http://my-proxy-server.mycompany.com:80). +- `Bypass Proxy Hosts` - The comma-separated list of DNS or IP patterns that should not go through the proxy. + For example, a value of `.us.mycompany.com,.emea.mycompany.com,.apac.mycompany.com` will skip the proxy for any + DNS name that ends in one of the three domain names. + +##### Logging Configuration + +Using this section, you can configure the logging output level and control the log file directory. The defaults are: + +- `File Transport Log Level` - The logging level below which log messages will be discarded. For example, `Debug` messages + will be discarded if the level is set to `Info`. The default value is `Info`. +- `Log File Directory` - The directory to which log files are written. The default is the user's temporary directory, as + defined by the operating system. + +##### WebLogic Kubernetes Toolkit UI Introduction Configuration + +This setting lets you turn on or off the in-application introductory information being displayed at startup. `Show Introduction` is always +accessible from the `Help` menu. + +#### External Applications + +The WKT UI application depends on several external applications for its functionality. As such, it is important to install and +configure these external applications properly on the local machine on which the application is running. + +- `docker` (or `podman`) - Used to create new images and inspect the contents of + custom base images. The WebLogic Image Tool depends on `docker` (or `podman`) for this functionality. `docker` + (or `podman`) is also used to log in to and interact with image registries. +- `kubectl` - Used to get, create, and update configuration objects in your Kubernetes cluster. + It is critical that the `kubectl` configuration file is properly set up to allow `kubectl` to authenticate to the cluster. +- `helm` - Used to install the WebLogic Kubernetes Operator and ingress controllers. +- `openssl` - Used to generate X.509 TLS certificates, should you ask the application to + generate one for your ingress route(s), only if you ask the application to generate it for you. + +#### Bundled WKT Applications + +[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) are bundled with the WKT UI application. These tools are: + +- WDT - Used to support discovering a model from an existing domain, prepare the model for a + particular Kubernetes target type, and is used by the WebLogic Image Tool when creating the domain inside the image. +- WIT - Used to create a new image for your WebLogic Server domain. It is also used to inspect any + custom base image that you might specify be used for creating the new image. + +Use `Help` > `Check For Updates` periodically to make sure you are using the latest versions of these +bundled tools. diff --git a/documentation/staging/1.2/content/developer/_index.md b/documentation/staging/1.2/content/developer/_index.md new file mode 100644 index 000000000..d33ece68c --- /dev/null +++ b/documentation/staging/1.2/content/developer/_index.md @@ -0,0 +1,48 @@ ++++ +title = "Developer Guide" +date = 2019-02-22T15:27:38-05:00 +weight = 4 +pre = " " ++++ + +The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment. + +### Setting up your development environment +1. Download and install the latest LTS version of `node.js` from [https://nodejs.org/en/download/](https://nodejs.org/en/download/). +2. If you rely on a proxy server to reach the Internet, set these five environment variables to configure the proxy correctly: + ``` + ELECTRON_GET_USE_PROXY=true + GLOBAL_AGENT_HTTPS_PROXY= + WKTUI_DEV_PROXY= + HTTPS_PROXY= + NO_PROXY= + ``` +3. Open a command line and run the following command to update the version of `npm` to the latest: + ```bash + sudo npm install --global npm + ``` +4. Set up your global git configuration by running the following commands: + ```bash + git config --global user.name "" + git config --global user.email "" + git config --global core.ignoreCase false + ``` + **This last command is critical if you are developing on either Windows or macOS. Yes, the macOS file system + is, by default, case-insensitive!** + +5. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui). +6. Open a command line in the `weblogic-toolkit-ui` directory and run `npm install` to download and install the JavaScript dependencies required by the project. +7. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run install-tools`. +8. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm start`. +9. After the server from the previous step is fully running, open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm start`. + +### Building a Windows or macOS installer +0. Set up your development environment and verify that the application is working properly from it. +1. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run build`. +2. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory. + +### Building a Linux installer +0. Set up your development environment and verify that the application is working properly from it. +1. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm run build:release`. +2. From the command line in the `weblogic-toolkit-ui/scripts` directory, run `./devBuildLinuxInstallers.sh`. +3. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory. diff --git a/documentation/staging/1.2/content/navigate/_index.md b/documentation/staging/1.2/content/navigate/_index.md new file mode 100644 index 000000000..f125e30d4 --- /dev/null +++ b/documentation/staging/1.2/content/navigate/_index.md @@ -0,0 +1,34 @@ ++++ +title = "Navigate the UI" +date = 2019-02-22T15:27:38-05:00 +weight = 3 +pre = " " ++++ + +### Before you begin + +Make sure you have read [About the WKT UI Application]({{< relref "/concepts/_index.md" >}}). + +### About the UI + +To help you understand how to use the WKT UI, we will step you through it, section by section, +describing the important decisions to make and fields to populate. The sections are listed in +the left side navigation pane. Depending on the `Kubernetes Environment Target Type` field +on the `Project Settings` page, you will see either the `Kubernetes` or `Verrazzano` section. + +The UI sections are: + +- [Project Settings]({{< relref "/navigate/project-settings.md" >}}) +- [Model]({{< relref "/navigate/model.md" >}}) +- [Image]({{< relref "/navigate/image.md" >}}) +- [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}}) + - [Client Configuration]({{< relref "/navigate/kubernetes/k8s-client-config.md" >}}) + - [WebLogic Operator]({{< relref "/navigate/kubernetes/k8s-wko.md" >}}) + - [WebLogic Domain]({{< relref "/navigate/kubernetes/k8s-weblogic-domain.md" >}}) + - [Ingress Controller]({{< relref "/navigate/kubernetes/k8s-ingress-controller.md" >}}) +- [Verrazzano]({{< relref "/navigate/verrazzano.md" >}}) + - Client Configuration + - Application + +At the bottom of the page, the collapsed `Console` panel automatically appears and displays the `stdout` and `stderr` +streams when running certain actions, such as `Prepare Model`. diff --git a/documentation/staging/1.2/content/navigate/image.md b/documentation/staging/1.2/content/navigate/image.md new file mode 100644 index 000000000..44962a01c --- /dev/null +++ b/documentation/staging/1.2/content/navigate/image.md @@ -0,0 +1,234 @@ +--- +title: "Image" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 3 +--- + +### Contents +- [Image](#image) +- [Design View](#design-view) + - [Target Image Name and Registry Credentials](#target-image-name-and-registr-credentials) + - [Base Image to Use](#base-image-to-use) + - [Installers for Building the Image](#installers-for-building-the-image) + - [Patch Oracle Home](#patch-oracle-home) + - [WebLogic Deploy Tooling Configuration](#weblogic-deploy-tooling-configuration) + - [Image Build Configuration](#image-build-configuration) +- [Code View](#code-view) +- [Create Images](#create-images) +- [Push Images](#push-images) + +### Image +The `Image` section helps you build container images for deploying WebLogic-based applications +in a Kubernetes environment using the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/). + +### Design View +The `Design View` helps you specify the necessary data needed to run the WebLogic Image Tool to build an image for +running the WebLogic domain. + +Use the `Design View` page to specify whether to create a new or use an existing (the default) `Primary Image` and +whether or not (the default) to use an `Auxiliary Image` (an existing one or create a new one). +**Note** that auxiliary images are available for the "Model in Image" [domain location]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}) _only_. + + +- **Primary Image** - The image containing the Oracle Fusion Middleware software. It is used as the basis of all containers that run WebLogic Servers for the domain. +- **Auxiliary Image** - The image that supplies the WebLogic Deploy Tooling software and the model files. At runtime, the auxiliary image's content is merged with the primary image's content. + + +{{< himg "Primary image diagram" "images/primary-image.png" "Auxiliary image diagram" "images/auxiliary-image.png" >}} + +The primary image is the one used for running the domain and the auxiliary image contains the data that defines the domain. One primary image can be +reused for hundreds of domains whereas an auxiliary image is domain-specific. When using auxiliary images, +the primary image contains the OS, JDK, and FMW software installations; the auxiliary image supplies the specifics for a single domain. + +If you select to create a new primary image, you'll see the following basic panes and a few advanced panes on the `Primary Image` Design View page. +If you select to create a new auxiliary image, you must select the `Auxiliary Image` Design View page, to configure it. +Note that _not all_ the fields described in the following sections for the `Primary Image`, are relevant for an `Auxiliary Image`. The exceptions are noted. + +- [Target Image Name and Registry Credentials](#target-image-name-and-registry-credentials) +- [Base Image to Use](#base-image-to-use) +- [Installers for Building the Image](#installers-for-building-the-image) +- [Patch Oracle Home](#patch-oracle-home) +- [WebLogic Deploy Tooling Configuration](#weblogic-deploy-tooling-configuration) +- [Image Build Configuration](#image-build-configuration) + +#### Target Image Name and Registry Credentials +The most important field in this pane is the `Image Tag` field. This is the name to give to the newly created image, +which must conform to the [image naming standards](https://docs.docker.com/engine/reference/commandline/tag/#extended-description). +Because most Kubernetes environments will need to pull the image from a container image registry (for example, Docker Hub), +the newly-created image typically will need to be pushed to the appropriate container image registry. Most registries +will require authentication as a user with the necessary permissions to push images. As described in the image naming +standards, the `Image Tag` field typically must include the DNS name of the container image registry prior to the first +slash (`/`) character. Images not containing a container image registry DNS name are assumed to be using Docker Hub. + +After the `Image Tag` field is populated, the application detects the presence of any prepended DNS name and displays the +value in the `Image Registry Address` field. This field is read-only so the only way to change the DNS name is to change +the value of the `Image Tag` field. The `Image Registry Push Username` +and `Image Registry Push Password` fields let you provide the user credentials needed to log in to the container +image registry prior to pushing the newly-created image. If explicit authentication is not required, then disable the +`Specify Image Push Credentials` option. If `Specify Image Push Credentials` is enabled, then any attempts to push the +image will fail unless the `Image Registry Push Username` and `Image Registry Push Password` fields are specified. + +#### Base Image to Use +By default, the WebLogic Image Tool uses an Oracle Linux base image when building the new image. To specify a different +base image, enable `Use Custom Base Image` and provide the base image's tag in the `Custom Base Image to Use` +field. Any container image registry address found in the base image tag will be displayed in the read-only +`Base Image Registry Address` field. If pulling the base image requires authentication, then enable +`Custom Base Image Pull Requires Login` and provide the necessary credentials in the +`Custom Base Image Pull Username` and `Custom Base Image Pull Password` fields. + +When using a custom base image, the application requires the image to be inspected using the WebLogic Image Tool's +[Inspect Image](https://oracle.github.io/weblogic-image-tool/userguide/tools/inspect-image/) command. **Note**: This +action is relevant for `Primary Images` only. To invoke this inspection, click +`Inspect Custom Base Image`. This inspection tells the application if Java or the +Oracle Fusion Middleware software is already installed in the image. If it finds either of these software packages +installed, then fields in the `Installers for Building the Image` pane will disappear because they are unneeded. + +In the current release, the `Patch Oracle Home` pane will disappear if the base image contains an Oracle Fusion +Middleware installation. The rationale being that the act of patching a base image installation will bloat the size of +the image. As such, it is better to either create the base image with the latest patches already installed or allow +the WebLogic Image Tool's multistage build to install and patch the Oracle Fusion Middleware installation while +minimizing the resulting image size. + +#### Installers for Building the Image +This pane will contain form fields for up to three installers (depending on the base image being used); they are: + +- JDK Installer (`Primary Images` only) +- Oracle Fusion Middleware Installer (`Primary Images` only) +- WebLogic Deploy Tooling Installer + +When specifying the `JDK Installer`, it is important to remember that this installer will be used to install the JDK inside +the Linux x64 image being created. Therefore, the `Linux JDK Installer to Use` field should always point to the +Linux x64 compressed archive installer (for example, `jdk-8u291-linux-x64.tar.gz`). While the value of the `JDK Version` field +is just a tag associated with the installer used to specify which version of the JDK installer that the WebLogic Image +Tool should use, the best practice is to set the value to the real version number (for example, `8u291` or `1.8.0_291`). + +The `Oracle Fusion Middleware Installer to Use` field must point to an installer that includes a modern version of +WebLogic Server (12.2.1.3 or later). Use the `Oracle Fusion Middleware Installer Type` field to tell the WebLogic Image +Tool which installer you are providing. It is important to make sure the type and installer match because installers of +different types require different fields to be specified during installation. As with the `JDK Version` field mentioned +previously, the `Oracle Fusion Middleware Version` field is just a tag to associate with the installer but the best +practice is to set the value to the actual Oracle Fusion Middleware version number (for example, `12.2.1.4.0`). + +By default, `Download and Use Latest WebLogic Deploy Tooling Installer` is enabled so that the application will +automatically download and use the latest, generally-available release in the WebLogic Deploy Tooling +[GitHub repository](https://github.com/oracle/weblogic-deploy-tooling/releases/). To specify a different installer, +disable `Download and Use Latest WebLogic Deploy Tooling Installer` and fill out the +`WebLogic Deploy Tooling Installer to Use` and `WebLogic Deploy Tooling Version` fields appropriately. As with the +other installers' version number fields, the best practice it to use the actual WebLogic Deploy Tooling version number +(for example, `1.9.17`). Note that new WDT versions often contain bug fixes or enhancements required to work with the +latest capabilities, many of which are exposed by this application. As such, using the latest version is strongly +recommended. + +{{% notice note %}} For "Model in Image" or "Domain in Image" [domain locations]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}), +when building your primary or auxiliary image, Oracle strongly recommends using [WDT 2.0](https://github.com/oracle/weblogic-deploy-tooling/releases). +Certain WKT UI actions, such as `Prepare Model`, may rewrite the model into a format that earlier WDT versions cannot parse. +{{% /notice %}} + + +#### Patch Oracle Home +**NOTE**: This pane is relevant for `Primary Images` only. Oracle strongly recommends patching all Oracle Fusion Middleware installations with the latest Patch Set Updates (PSUs) +and other recommended patches to ensure that the latest security fixes are applied. This pane configures the WebLogic +Image Tool to apply the specified patches to the Oracle Home during the image creation process. There are two mechanisms +for specifying that patches should be applied: + +- Radio buttons to specify what patch bundles should be applied. +- The list of patch numbers to apply. + +The patch bundle radio buttons provide three choices: + +- `None` - Applies no bundle patches. +- `Apply Latest PSU Only` - Applies the latest PSU patch but no + other recommended patches. +- `Apply All Recommended Patches` - Applies all recommended patches, which always includes + the latest PSU, in addition to other important fixes. + +Use the `Individual Patches to Apply` field to specify individual patch numbers to apply. These patches will be applied +after any patch bundles specified. + +The WKT UI application requires that valid Oracle Support credentials be specified using the `Oracle Support Username` and +`Oracle Support Password` fields. This allows the WebLogic Image Tool to automatically discover the latest PSU and +recommended patches and download any patches specified as part of the image creation process. + +As a last resort, if no valid Oracle Support credentials are available, the patching process can be skipped by disabling +the `Apply Patches` option. _To make sure your WebLogic-based applications are +as secure as possible, this really should be a last resort._ + +#### WebLogic Deploy Tooling Configuration +This `Advanced` pane applies only to images using either the "Model in Image" or "Domain in Image" [domain locations]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}). + +For "Domain in Image" only, the `Domain Type` field tells WebLogic Deploy Tooling what type of domain to create. Use the `Domain Home Directory` +to change the location of the WebLogic domain directory inside the container. For "Model in Image" and "Domain in Image", the `Model Home Directory` field +specifies the directory where the WDT model files are stored in the image and `WDT Home Directory` specifies the WDT home directory inside the image. +Typically, there is no need to override these directory locations because the application defaults follow the recommended best practices. + +#### Image Build Configuration +This `Advanced` pane supports altering the default behavior of the WebLogic Image Tool, as well as extending the image +build process to include custom build steps that might be required by particular applications or environments. + +The `JDK/FMW Installation Owner` and `JDK/FMW Installation Group` fields specify the Linux user and group that should +own the JDK and Oracle Fusion Middleware installation directories. The default values are generally fine for most +environments. + +For any images intended to run in an OpenShift environment, where the configured Security Context Constraints cause the containers +to run as a random user in the root group, select `Make Image Compatible with OpenShift`. +This option changes the default group name to root and gives the group file system write access, as required by OpenShift. +For more information, see +[Managing security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) +in the OpenShift documentation. + +If the base image is expected to change without the image tag changing, then enable `Always Pull Base Image`. With +this option enabled, the image build process will always pull a new version of the base image to ensure that the latest +version is being used. Otherwise, the base image will be pulled only if it doesn't already exist in the local machine's +image cache. + +The `Image Build Network Name` field allows an image build to run when the build process needs access to another +container, such as a database that might be running in a container that is needed while WDT is creating the domain. +Because the current release doesn't support creating JRF domains during the image build process (that is, for the +"Domain in Image" domain location), it is unlikely that this field will be needed. However, it is surfaced +for completeness. + +To add custom steps to the image build process, enable `Extend Image Build` and provide the Dockerfile +containing the additional commands in the `Additional Build Commands File` field. If the specified Dockerfile needs +additional files to be present in the build context directory, then provide the list of those required files in the +`Additional Build Files` field. + +### Code View +For the `Primary Image`, the `Code View` displays a shell script that you can use as a starting point for automating the image +creation process. For the "Model in Image" [domain location]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}), there is a +similar `Code View` page for the `Auxiliary Image`. Each page shows the script for creating and pushing its image. + +If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note +that the application is providing a working sample script simply to show how the process might be automated. Before +using the script, review the script and make any changes necessary for your environment. One typical change that +would be considered a best practice would be to change the script to accept either command-line arguments or externally +set environment variables to specify any credentials required by the script to eliminate hard-coding the credentials in +the script itself. This change is left as an exercise for you because different environments typically will have +existing standards for securely handling such credentials. + +### Create Images +`Create Primary Image` and `Create Auxiliary Image` invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) to +create a new container image for running a WebLogic domain in a Kubernetes environment. You access these actions using +the `Create Primary Image` or `Create Auxiliary Image` button on the `Image` page or from the `Go` menu. + +At a high level, the action performs the following steps: + +1. Validates the input values necessary for running the action based on your selections. +2. Saves the WKT Project, if needed. +3. Adds the installers to the WIT cache on the local machine using the WebLogic Image Tool + [Cache](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/) command. +4. Builds the image on the local machine using the WebLogic Image Tool + [Create](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) command. + +### Push Images +`Push Primary Image` and `Push Auxiliary Image` use the specified Image Builder program to upload (that is, push) the newly-built image +to the image registry specified by its image tag. You access these actions by using the `Push Primary Image` or `Push Auxiliary Image` button on the `Image` +page or from the `Go` menu. + +At a high level, the action performs the following steps: + +1. Validates the input values necessary for running the action based on your selections. This includes making + sure that an image with the specified `Image Tag` value exists in the local machine's image cache. +2. Saves the WKT Project, if needed. +3. Logs in to the container image registry, if specified. +4. Pushes the image to the container image registry. diff --git a/documentation/staging/1.2/content/navigate/kubernetes/_index.md b/documentation/staging/1.2/content/navigate/kubernetes/_index.md new file mode 100644 index 000000000..ad44cdebb --- /dev/null +++ b/documentation/staging/1.2/content/navigate/kubernetes/_index.md @@ -0,0 +1,18 @@ ++++ +title = "Kubernetes" +date = 2019-02-22T15:27:38-05:00 +weight = 5 +pre = " " ++++ + +The `Kubernetes` section and its four subsections support deploying a WebLogic-based application to a +Kubernetes cluster where the WebLogic domain will be managed by the WebLogic Kubernetes Operator. It includes sections +to help you: + +1. [Configure]({{< relref "/navigate/kubernetes/k8s-client-config#client-configuration" >}}) your Kubernetes client (`kubectl`) to connect to the Kubernetes cluster. +2. [Install]({{< relref "/navigate/kubernetes/k8s-wko#install-operator" >}}) the WebLogic Kubernetes Operator. +3. [Deploy]({{< relref "/navigate/kubernetes/k8s-weblogic-domain#deploy-domain" >}}) the WebLogic domain's `Domain` resource configuration used by WebLogic Kubernetes Operator. +4. [Install]({{< relref "/navigate/kubernetes/k8s-ingress-controller#install-ingress-controller" >}}) an ingress controller, if needed, and add ingress routes to allow access to the WebLogic domain from + outside the Kubernetes cluster. + +{{% children style="h4" description="true" %}} diff --git a/documentation/staging/1.2/content/navigate/kubernetes/k8s-client-config.md b/documentation/staging/1.2/content/navigate/kubernetes/k8s-client-config.md new file mode 100644 index 000000000..c7b7237c6 --- /dev/null +++ b/documentation/staging/1.2/content/navigate/kubernetes/k8s-client-config.md @@ -0,0 +1,74 @@ +--- +title: "Client Configuration" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 1 +description: "Client Configuration helps you get the necessary connectivity to your Kubernetes cluster." +--- + + + +### Contents + +- [Client Configuration](#client-configuration) + - [Authentication with Managed Kubernetes Clusters](#authentication-with-managed-kubernetes-clusters) + - [Verify Connectivity](#verify-connectivity) + +### Client Configuration +`Client Configuration` helps you get the necessary connectivity to your Kubernetes +cluster. Use the `Kubernetes Cluster Type` field to select the target Kubernetes cluster type to show instructions for +configuring `kubectl` to successfully connect to the cluster. + +- The `Kubectl Executable to Use` field tells the WKT UI application where to find the correct version of `kubectl` to use. +- By using the `Kubernetes Client Config File(s)` field, you can specify a different Kubernetes client configuration +file instead of, or in addition to, the default `.kube/config` file from your home directory. +- For environments where the client is configured to connect to multiple clusters, use the `Kubernetes Config Context to Use` field to +specify the configuration file's context associated with the cluster to which you want to connect. +- The `Helm Executable to Use` field tells the application where to find Helm, which is used to install the WebLogic +Kubernetes Operator and ingress controllers. For more information +about Helm, see the [Helm](https://helm.sh/) documentation. + +#### Authentication with Managed Kubernetes Clusters +Most cloud vendors require the use of their command-line tooling to authenticate `kubectl` connections to their managed +Kubernetes clusters. For example, after `kubectl` is configured to connect to a Kubernetes cluster managed by the +Oracle Kubernetes Engine (OKE), the Kubernetes client configuration file will have a section that looks similar to the +one shown here. + +``` +users: +- name: user-abcdefghi8d + user: + exec: + apiVersion: client.authentication.k8s.io/v1beta1 + command: oci + args: + - ce + - cluster + - generate-token + - --cluster-id + - ocid1.cluster.oc1.phx.aaaaaaaaahdirjdmcjfpogfkdhjsdhshssk2abcdefghijk2d + - --region + - us-phoenix-1 + env: [] +``` + +This configuration causes each `kubectl` invocation that references this user definition to execute the `oci` command +(the Oracle Cloud command-line tool) to get the credentials necessary to successfully authenticate to the cluster. +If the `oci` executable is not in a directory in the `PATH` environment variable when the `kubectl` command is executed, +then an error similar to the one shown here will occur. + +``` +Failed to verify Kubernetes client connectivity: Unable to verify Kubernetes client connectivity: +Command failed: /Users/rpatrick/bin/kubectl version --short +Unable to connect to the server: getting credentials: exec: executable oci not found + +It looks like you are trying to use a client-go credential plugin that is not installed. + +To learn more about this feature, consult the documentation available at: +https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins. +``` + +#### Verify Connectivity +To verify the application configuration for connecting to the specified Kubernetes cluster, +use the `Verify Connectivity` button on the `Client Configuration` page or +`Go` > `Verify Kubernetes Client Connection`. diff --git a/documentation/staging/1.2/content/navigate/kubernetes/k8s-ingress-controller.md b/documentation/staging/1.2/content/navigate/kubernetes/k8s-ingress-controller.md new file mode 100644 index 000000000..9c091a13e --- /dev/null +++ b/documentation/staging/1.2/content/navigate/kubernetes/k8s-ingress-controller.md @@ -0,0 +1,132 @@ +--- +title: "Ingress Controller" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 4 +description: "Install and configure an ingress controller." +--- + +### Contents +- [Ingress Controller](#ingress-controller) +- [Design View](#design-view) + - [Ingress Controller Configuration](#ingress-controller-configuration) + - [TLS Secret for Ingress Routes](#tls-secret-for-ingress-routes) + - [Ingress Routes Configuration](#ingress-routes-configuration) +- [Code View](#code-view) +- [Install Ingress Controller](#install-ingress-controller) +- [Update Ingress Routes](#update-ingress-routes) +- [Uninstall Ingress Controller](#uninstall-ingress-controller) + +### Ingress Controller +This section supports two distinct functions related to an ingress controller. First, it supports installing an ingress +controller to a Kubernetes cluster. Second, it supports adding the necessary routes to an ingress controller to make +a deployed WebLogic domain's endpoints accessible. + +### Design View +`Design View` helps you specify the data needed to install an ingress controller, if desired, and +specify the data needed to expose one or more endpoints for a deployed WebLogic domain. This page contains three panes: + +- [Ingress Controller Configuration](#ingress-controller-configuration) +- [TLS Secret for Ingress Routes](#tls-secret-for-ingress-routes) +- [Ingress Routes Configuration](#ingress-routes-configuration) + +#### Ingress Controller Configuration +The most important field in this pane is the `Ingress Provider` field. This fields tells the WKT UI application with which of the +supported ingress controllers it will need to work. The current release supports two ingress +controllers: + +- NGINX +- Traefik + +To install the ingress controller, enable `Install Ingress Controller`. +- To set the release name used by the Helm install process, use the `Helm Release Name to Use` field. +- Set the Kubernetes namespace to which the ingress controller should be installed with the `Ingress Controller Namespace` field. + +The container image for the Traefik ingress controller resides in Docker Hub. Due to changes made +to Docker Hub, anonymous pull requests are throttled. This can result in pull requests being denied when the Kubernetes +cluster attempts to pull the image and start the container. +- To work around this limitation, enable the `Use Docker Hub Secret` field to provide login credentials for Docker Hub. +- The `Docker Registry Secret Name` field specifies the name of the Kubernetes pull secret to use when pulling the image. +To create this secret, enable `Create Docker Hub Secret` and fill in the pull secret data in the `Docker Hub Username`, `Docker Hub Password`, +and `Docker Hub Email Address` fields. +- For the NGINX ingress controller, if you want to have SSL pass through the ingress route, enable `Allow SSL pass through to target service`. + +#### TLS Secret for Ingress Routes +Use this pane to configure the Transport Layer Security (TLS) secret containing the certificate and private key data that will be used by the +ingress controller when establishing HTTPS connections from clients to the ingress controller. The TLS connection will be +terminated at the ingress controller, so traffic between the ingress controller and services/pods will not be encrypted. +In the current release, only a single TLS certificate is supported for the routes being defined. + +- To use TLS-enabled routes, enable `Use Ingress TLS Secret` and provide the secret name using the +`Ingress TLS Secret Name` field. +- To have the application create this secret, enable `Create Ingress TLS Secret`. +- If you already have a certificate file and its corresponding private key file, then use the `TLS Certificate File` +and `TLS Private Key File` fields to provide them. +- To create these files automatically, enable `Generate a TLS Certificate and Private Key`. + - Provide the path to the OpenSSL executable using the +`OpenSSL Executable to Use` field. + - Use the `Subject to Use for the Generated TLS Certificate` field to specify the data +to put into the subject of the certificate. + - For example, if your ingress route will use the virtual host name +`www.myapp.com`, you might specify the subject contents as `/CN=www.myapp.com`. + - The subject data will support multiple +key/value pairs using a comma-separated syntax, like `/key1=value1,/key2=value2,/key3=value3`. + +#### Ingress Routes Configuration +Use the table in this section to define the ingress routes to be added by the application. _Note that this table does +not currently display existing routes already defined._ Any routes defined in or removed from the table will happen in +the WKT Project object. When applying or updating the routes, only the fields currently in the table will be considered. +If the routes do not exist, then they will be added. If one or more of the routes already exists, then the application will warn +you to confirm whether you want to update the existing route or routes before performing the operation. + +To add a new route, click the plus (`+`) button in the table header. To edit a route, use the edit button on the corresponding +route row. To remove a route, use the delete icon on the corresponding route row. + +When editing a route: +- Use the `Name` field to set the route name. +- Use the `Virtual Host` and `Path Expression` fields to define the matching rules that determine which requests match this route. +- All requests in the defined rules are routed to the service specified by the `Target Service` field that resides in the namespace specified by the read-only +`Target Service Namespace` field and the port specified by the `Target Port` field. After the domain has been deployed, you can select the `Target Service` + value from the drop-down list of available services in the WebLogic Kubernetes Operator domain's namespace. After the `Target Service` is selected, + you can select the `Target Port` from the list of available ports in the selected target service. +- Specify the `Transport Option` for the ingress route: + * Select `Plain HTTP` for unencrypted traffic from the client through the ingress controller to the target service. + * Select `SSL terminate at ingress controller` for SSL + terminating + at the ingress controller and then unencrypted traffic from the ingress controller to the target service. + * Enable `Is target service WebLogic Console?` if the target service is the `WebLogic Console` service. + * Select `SSL pass through` for SSL traffic to pass through the ingress + controller and then terminate at the target service. + * If you select this option, you must also specify a valid DNS value in 'Virtual Host', and all SSL traffic from + the`Virtual Host` will be routed to the target service. + * Make sure that the `Target Port` supports SSL. +- Use the `Ingress Route Annotations` table to +add annotations to the ingress route, as needed. Do not remove any pre-populated annotations. + +### Code View +The `Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also +displays the YAML definitions of the routes to be added, if applicable. + +If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note +that the application is providing a working sample script simply to show how the process might be automated. Before +using the script, review the script and make any changes necessary for your environment. One typical change that +would be considered a best practice would be to change the script to accept either command-line arguments or externally +set environment variables to specify any credentials required by the script to eliminate hard-coding the credentials in +the script itself. This change is left as an exercise for you because different environments typically will have +existing standards for securely handling such credentials. + +### Install Ingress Controller +`Install Ingress Controller` creates any namespace and secret specified and runs the ingress controller's Helm +chart to install the ingress controller. You access this action by using the `Install Ingress Controller` button on the +`Ingress Controller` page or the `Go` > `Install Ingress Controller` menu item. + +### Update Ingress Routes +`Update Ingress Routes` creates the TLS secret, if needed, and adds or updates the specified ingress routes. You access this action +by using the `Update Ingress Routes` button on the `Ingress Controller` page or +the `Go` > `Update Ingress Routes to Domain` menu item. + +### Uninstall Ingress Controller +`Uninstall Ingress Controller` uses the `helm uninstall` command to remove all the ingress resources +and uninstall the ingress controller. In addition, you can choose whether to also delete the corresponding namespace. +You access these actions by using the `Uninstall Ingress Controller` button on the +`Ingress Controller` page or the `Go` > `Uninstall Ingress Controller` menu item. diff --git a/documentation/staging/1.2/content/navigate/kubernetes/k8s-weblogic-domain.md b/documentation/staging/1.2/content/navigate/kubernetes/k8s-weblogic-domain.md new file mode 100644 index 000000000..6963d1afd --- /dev/null +++ b/documentation/staging/1.2/content/navigate/kubernetes/k8s-weblogic-domain.md @@ -0,0 +1,259 @@ +--- +title: "WebLogic Domain" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 3 +description: "Create and deploy the Kubernetes custom resource for the WebLogic domain." +--- + +### Contents +- [WebLogic Domain](#weblogic-domain) +- [Design View](#design-view) + - [Primary Image to Use for the Domain](#primary-image-to-use-for-the-domain) + - [Auxiliary Image to Use for the Domain](#auxiliary-image-to-use-for-the-domain) + - [Clusters](#clusters) + - [Model Variables Overrides](#model-variables-overrides) + - [Secrets](#secrets) + - [Runtime Encryption Secret](#runtime-encryption-secret) + - [WebLogic Kubernetes Operator Introspection Configuration](#weblogic-kubernetes-operator-introspection-configuration) + - [Domain-Wide Server Settings](#domain-wide-server-settings) +- [Code View](#code-view) +- [Prepare Model](#prepare-model) +- [Deploy Domain](#deploy-domain) +- [Get Domain Status](#get-domain-status) +- [Undeploy Domain](#undeploy-domain) + +### WebLogic Domain +The `WebLogic Domain` section provides support for creating and deploying the Kubernetes custom resource for the WebLogic domain as +defined by the WebLogic Kubernetes Operator. For more information, see +[Domain Resource](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/) +in the WebLogic Kubernetes Operator documentation. + +### Design View +The `Design View` helps you specify the necessary data needed to generate the Domain resource definition and deploy +that resource into a Kubernetes cluster. + +The `Domain UID` field defines the name of the Kubernetes Domain custom resource object. This name must be unique +within the Kubernetes namespace where it will be created, which is controlled by the `Kubernetes Namespace` field. + +The default value of the `Domain UID` field is based on the WebLogic domain's name, as defined by the WDT model: + +- When using either "Model in Image" or "Domain in Image" [domain location]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}), +the `Domain Home Path` field is read-only and its value is set using the `Domain Home Directory` field under `Advanced`. +- When using "Domain in PV", this field must be set to the fully +qualified path to the domain home directory in the persistent volume. For example, if the persistent volume mount +path is set to `/shared` and the domain home is located in `/domains/mydomain` in the persistent volume, then the +`Domain Home Path` field must be set to `/shared/domains/mydomain`. + +For "Model in Image", use the `Domain Type` field to specify the type of domain to create using the model. + +Set the Kubernetes secret name where the WebLogic domain credentials will be stored using the +`WebLogic Credentials Secret Name` field. Set the value of the WebLogic Server administration credentials using the +`WebLogic Admin Username` and `WebLogic Admin Password` fields. Remember that these fields must be set appropriately +for the selected domain location: + +- For "Model in Image", these fields are used to set the WebLogic Server credentials used to create the domain, and + by the operator at runtime to perform actions on the domain (for example, start a server). +- For "Domain in Image", the domain was created using the WebLogic Image Tool using the credentials specified in the + model. These values must match the ones used during the image creation process. +- For "Domain in PV", the domain was created outside the application so the values provided in these fields must match + the ones used when the domain was created. + +When using "Domain in PV", three additional fields associated with the persistent volume will be shown: + +- `Persistent Volume Name` - The name of the persistent volume to use in the Domain resource file. +- `Persistent Volume Claim Name` - The persistent volume claim to associate with the persistent volume. +- `Persistent Volume Mount Path` - The path to the persistent volume within the container(s). +- `Enable Log Home` - Enables the ability to separate the logs directory from the domain directory on the persistent + volume. +- `Log Home Path` - The path to use for the log home when `Enable Log Home` is enabled. + +The following sections describe the other panes that support configuring the generated Domain resource; they are: + +- [Primary Image to Use for the Domain](#primary-image-to-use-for-the-domain) +- [Auxiliary Image to Use for the Domain](#auxiliary-image-to-use-for-the-domain) +- [Clusters](#clusters) +- [Model Variables Overrides](#model-variables-overrides) +- [Secrets](#secrets) +- [Runtime Encryption Secret](#runtime-encryption-secret) +- [WebLogic Kubernetes Operator Introspection Configuration](#weblogic-kubernetes-operator-introspection-configuration) +- [Domain-Wide Server Settings](#domain-wide-server-settings) + +#### Primary Image to Use for the Domain +This pane focuses on the container primary image to use to run the WebLogic Server domain in a container. If you select `Create a New Primary Image`, +then click `Go To Create Primary Image Page` to configure the image. For detailed information, see the [Image]({{< relref "/navigate/image.md" >}}) section. + +- When using either "Model in Image" or "Domain in Image" [domain location]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}), the `Primary Image Tag` field is read-only; its value is set using the +`Image Tag` field in the `Image` section. +- In the case of "Domain in PV", the `Image Tag` field is not read-only and _is_ +the place to specify the image to use to run the WebLogic domain's containers. +- The read-only `Image Registry Address` field is populated by parsing the value of the `Image Tag` field +to extract any container image registry address. If the tag has no image registry address, then it is assumed to reside on Docker Hub. + +Use the `Primary Image Pull Policy` field to specify when Kubernetes should pull the image from the specified image registry. +The choices are: + +- `If Not Present` (default) - Only pull the image if it is not already present on the Kubernetes node. +- `Always` - Pull the image every time the image is needed to start a container. +- `Never` - Never pull the image; this will result in an error if the image is not already present on the Kubernetes node. + +If pulling the image from the specified image registry does not require authentication, +then `Specify Image Pull Credentials` should be disabled. When enabled, use the `Use Existing Image Pull Secret` field to tell the application +whether to use an existing image pull secret or create a new one. Specify the image pull secret name in the +`Image Pull Secret Name` field. When creating a new secret, specify the secret data using the +`Image Registry Pull Username`, `Image Registry Pull Email Address`, and `Image Registry Pull Password` fields. + +#### Auxiliary Image to Use for the Domain + +Under `Auxiliary Image Configuration`, use the radio buttons to specify whether or not to use an Auxiliary Image (an existing one) or create a new one (the default). +If you select `Create a New Auxiliary Image`, then click `Go To Create Auxiliary Image Page` to configure the image. For detailed information, +see the [Image]({{< relref "/navigate/image.md" >}}) section. + +For "Model in Image" domains only, this pane focuses on the container auxiliary image to use for the domain. +- The `Auxiliary Image Tag` field is read-only; its value is set using the +`Auxiliary Image Tag` field in the `Auxiliary Image` page of the `Image` section. +- Use the `Auxiliary Image Pull Policy` field to specify when to pull the domain's auxiliary image from the image registry. The choices are: + + - `If Not Present` (default) - Only pull the image if it is not already present. + - `Always` - Pull the image every time the image is needed to start a container. + - `Never` - Never pull the image; this will result in an error if the image is not already present. + +If pulling the image from the specified image registry does not require authentication, +then `Specify Auxiliary Image Pull Credentials` should be disabled. When enabled, use the `Use Existing Auxiliary Image Pull Secret` field to tell the application +whether to use an existing image pull secret or create a new one. Specify the image pull secret name in the +`Auxiliary Image Pull Secret Name` field. When creating a new secret, specify the secret data using the +`Auxiliary Image Registry Pull Username`, `Auxiliary Image Registry Pull Email Address`, and `Auxiliary Image Registry Pull Password` fields. + + +#### Clusters +The Clusters pane lists the names of each cluster in the model and lets you adjust the WebLogic Server +startup configuration and Kubernetes resource requests and limits. It is currently populated when `Prepare Model` is run, +which means that projects using "Domain in PV" will not have access to adjust the configuration at the cluster level. +"Domain in PV" projects can still use the `Domain-Wide Server Settings` pane under `Advanced`. + +To view or edit the settings for a cluster, select the edit icon at the right end of the cluster's row in the +table. This opens a dialog that shows all the cluster-related fields and their values. The read-only +`Cluster Name` field shows the name of the cluster, as specified in the underlying model. + +Use the `Replicas` field to adjust the number of managed servers that the WebLogic Kubernetes Operator should start when the domain is deployed. +The default value for the `Replicas` field is set based on the maximum number of servers specified by the model: +- In the case of a static cluster, it will be the number of servers that are configured to be part of the cluster. +- When using a dynamic cluster, the value is set based on the maximum number of servers that the dynamic cluster allows. +- This default value also serves as the upper limit for the `Replicas` field. In other words, you may only reduce the number of +replicas. It is not possible to increase the replica count above the maximum limit defined by the model. + +Use the `Minimum Heap Size` and `Maximum Heap Size` fields to control the amount of Java heap space available for each +server in the cluster. Specify any additional Java command-line options with the `Additional Java Options` +field. + +`Disable debug logging to standard out` disables WebLogic Server debug log messages from being +written to standard out. In WebLogic Server 12.2.1.3.0, there is an issue that impacts the Oracle JDBC driver +processing FAN (Fast Application Notification) events from an Oracle Database. To work around this issue, enable +`Disable Oracle JDBC Support for FAN Events`. + +`Use pseudo-random number generator` controls whether +WebLogic Server uses the pseudo-random number generator (that is, `/dev/urandom`) or the regular random number generator +(that is, `/dev/random`). Because the latter is impacted by the available entropy, it can negatively impact performance when +running WebLogic Server on a virtual machine or in a container. Because the servers being configured by this application +will always be running in a container, the default is set to use the pseudo-random number generator. + +The Kubernetes resource requests and limits values help the Kubernetes scheduler determine which node to use to start +a container (to ensure there are sufficient resources available for the container to run). The following fields allow +these values to be specified: + +- `Kubernetes CPU Request` - The requested amount of CPU for each managed server's container. +- `Kubernetes CPU Limit` - The maximum amount of CPU each managed server's container is allowed to use. +- `Kubernetes Memory Request` - The requested amount of memory for each managed server's container. +- `Kubernetes Memory Limit` - The maximum amount of memory each managed server's container is allowed to use. + +For more information about these fields and setting their values, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory). + +#### Model Variables Overrides +Use this pane to override values of model variables when using "Model in Image" to customize the model data already set +in the image. For example, the image may contain a variable whose value refers to a JDBC URL to connect to a database. +Because the image may be used across development, test, and production environments, overriding the JDBC URL to point to +the correct database for the environment helps make the same image usable across all three environments. All override +values are added to a Kubernetes ConfigMap that is passed to the WebLogic Kubernetes Operator so that it creates the +underlying WebLogic Server domain with the correct values for the environment. + +If the model has one or more variables, then the `Kubernetes Config Map Name` field is visible and allows the name of the +Kubernetes ConfigMap name to be controlled. The table will be populated with the model variables, as defined by the +model variables file. Because the model variables file is typically already set in the image by the time you +reach this page, both the `Model Variable Name` and the `Model Variable File Value` entries are read-only. Enter an +`Model Variable Override Value` for any variable whose `Model Variable File Value` should be overridden. Note that the +ConfigMap will only be created if one or more variables have an override value specified. + +#### Secrets +When using "Model in Image", use this pane to set the value of any secrets referenced in the model (other than the WebLogic administrator credentials +secret). The secrets that appear in the table are pulled from the model file directly; +as such, the `Secret Name` field is read-only. Set the appropriate `Username` and `Password` field values for each +secret in the table. These values are required and will be used to create or update the secret with the specified +values. + +#### Runtime Encryption Secret +When using "Model in Image", the WebLogic Kubernetes Operator requires a runtime encryption secret it uses to encrypt +sensitive WebLogic Server domain data stored in Kubernetes. For more information, see +[Required runtime encryption secret](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/usage/#required-runtime-encryption-secret) +in the WebLogic Kubernetes Operator documentation. + +Use the `Runtime Encryption Secret Name` field to control the name of the secret, if needed. Typically, the default +name is sufficient. The `Runtime Encryption Secret Value` field's default value is generated but may be changed, if +desired. + +#### WebLogic Kubernetes Operator Introspection Configuration +This pane controls the WebLogic Kubernetes Operator introspection job configuration. Use the +`Introspection Job Active Deadline Seconds` field to control how long the operator waits for the introspection job to +complete. The application sets the default to 900 seconds (15 minutes); this overrides the underlying default of 120 +seconds (2 minutes) built into the operator. As such, clearing the value of this field will cause the effective value +to be set to 120 seconds. + +#### Domain-Wide Server Settings +This pane lets you adjust the WebLogic Server startup configuration and Kubernetes resource requests and +limits default values for every WebLogic Server container in the WebLogic Server domain. Any fields set here will be +applied only if they are not overridden elsewhere. For example, setting the `Minimum Heap Size` will set +WebLogic Server's minimum heap size to the specified value only if the cluster to which the server belongs does not +override the minimum heap size. For typical domains with an Administration Server and one or more clusters, the best practice is +to use this section to configure the Administration Server and use the `Clusters` pane to configure each cluster explicitly. + +The fields in this pane have similar meaning to the equivalent fields previously described in +[Clusters](#clusters); refer to that section for more information. + +### Code View +The `Code View` displays a shell script for deploying the domain and creating its dependent resources as well as +the YAML definition for the Kubernetes custom resource (that is, the Domain resource) and the Model Variables Overrides +ConfigMap, if applicable. + +If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note +that the application is providing a working sample script simply to show how the process might be automated. Before +using the script, review the script and make any changes necessary for your environment. One typical change that +would be considered a best practice would be to change the script to accept either command-line arguments or externally +set environment variables to specify any credentials required by the script to eliminate hard-coding the credentials in +the script itself. This change is left as an exercise for you because different environments typically will have +existing standards for securely handling such credentials. + +### Prepare Model +`Prepare Model` is the same as was previously described in the [`Model`]({{< relref "/navigate/model#prepare-model" >}}) section. It is only +surfaced here because the `Clusters` pane of the `Design View` is populated only when `Prepare Model` is run. + +### Deploy Domain +`Deploy Domain` creates the Domain custom resource object and any of its dependent objects (for example, +namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Domain` button on the +`WebLogic Domain` page or the `Go` > `Deploy WebLogic Domain to Kubernetes` menu item. As previously +mentioned, this action also updates the operator configuration, if needed, and reruns the operator Helm chart to ensure +that the new namespace is manageable by the WebLogic Kubernetes Operator configured for this project. + +`Deploy Domain` completes as soon as the objects are created and the operator Helm chart execution completes. At some point +after the action completes, the operator will detect a new (or updated) version of the Domain custom resource object and +start a new introspection job to create the domain and start or restart the WebLogic Server containers. `Get Domain Status` +provides the current status of the last `Deploy Domain` action. + +### Get Domain Status +To view the current status of the last domain deployment, use the `Get Domain Status` button or the +`Go` > `Get WebLogic Domain Status`. This action retrieves and displays the domain deployment +status, as provided by the WebLogic Kubernetes Operator. + +### Undeploy Domain +`Undeploy Domain` removes the Kubernetes custom resource for the WebLogic domain and its +dependent objects in Kubernetes. In addition, you can choose whether to also delete the corresponding namespace. +You access these actions by using the `Undeploy Domain` button on the +`WebLogic Domain` page or the `Go` > `Undeploy WebLogic Domain to Kubernetes` menu item. diff --git a/documentation/staging/1.2/content/navigate/kubernetes/k8s-wko.md b/documentation/staging/1.2/content/navigate/kubernetes/k8s-wko.md new file mode 100644 index 000000000..c25b5ccd7 --- /dev/null +++ b/documentation/staging/1.2/content/navigate/kubernetes/k8s-wko.md @@ -0,0 +1,202 @@ +--- +title: "WebLogic Kubernetes Operator" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 2 +description: "Install the WebLogic Kubernetes Operator in the target Kubernetes cluster." +--- + + + +### Contents +- [WebLogic Kubernetes Operator](#weblogic-kubernetes-operator) +- [Design View](#design-view) + - [WebLogic Kubernetes Operator Image](#weblogic-kubernetes-operator-image) + - [Image Pull Secret](#image-pull-secret) + - [Kubernetes Namespace Selection Strategy](#kubernetes-namespace-selection-strategy) + - [WebLogic Kubernetes Operator Role Bindings](#weblogic-kubernetes-operator-role-bindings) + - [External REST API Access](#external-rest-api-access) + - [Third Party Integrations](#third-party-integrations) + - [Java Logging](#java-logging) +- [Code View](#code-view) +- [Install Operator](#install-operator) +- [Update Operator](#update-operator) +- [Uninstall Operator](#uninstall-operator) + +### WebLogic Kubernetes Operator +This section provides support for installing the WebLogic Kubernetes Operator (the "operator") in the target Kubernetes cluster. +For detailed information about the operator, see the +[WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) documentation. + +### Design View +The `Design View` helps you specify the necessary data needed to install the WebLogic Kubernetes Operator to manage +WebLogic domains in one or more Kubernetes namespaces. To install the operator using the default settings, simply +provide values for the following three fields: + +- `Kubernetes Namespace` - The Kubernetes namespace to which to install the operator. +- `Kubernetes Service Account` - The Kubernetes service account for the operator to use when making Kubernetes API + requests. +- `Helm Release Name to Use for Operator Installation` - The Helm release name to use to identify this installation. + +{{% notice note %}} +The WKT UI application overrides a few default values in the operator Helm Chart. Read the details of the parameters descriptions in +[Kubernetes Namespace Selection Strategy](#kubernetes-namespace-selection-strategy). These panes and their fields are made visible by expanding the +`Advanced` portion of the page. +{{% /notice %}} + +#### WebLogic Kubernetes Operator Image +By default, the operator's `Image Tag to Use` field is set to the image tag corresponding to the latest operator +release version on the GitHub Container Registry. The `Image Pull Policy` field configures the operator deployment in +Kubernetes to tell it when to pull the image from the specified registry: + +- `If Not Present` (default) - Only pull the image if it is not already present on the Kubernetes node. +- `Always` - Pull the image every time the image is needed to start a container. +- `Never` - Never pull the image; this will result in an error if the image is not already present on the Kubernetes node. + +Because the GitHub Container Registry does not require image pull authentication to pull the official WebLogic Kubernetes +Operator image, `Image Pull Requires Authentication` is disabled by default. If a custom +operator image is being used from a container image registry that requires pull authentication, then enable the option +and complete the appropriate fields described in the [Image Pull Secret](#image-pull-secret) +pane that follows. + +#### Image Pull Secret +This pane is hidden unless the `Image Pull Requires Authentication` from the WebLogic Kubernetes Operator Image pane +is enabled. To allow Kubernetes to pull the custom operator image requiring pull authentication, use the +`Kubernetes Image Pull Secret Name` field to provide the name of the Kubernetes secret to use for the credentials. To +have the application create this secret, disable `Use Existing Secret` and provide the values for the following +fields: + +- `Image Pull Secret Email Address` - The email address of the user. +- `Image Pull Secret Username` - The user name to use when authenticating to the container image registry. +- `Image Pull Secret Password` - The user's password to use when authenticating to the container image registry. + +The read-only `Image Registry Address` field is parsed from the `Image Tag to Use` field. If the +`Image Registry Address` field is empty, then the application will assume that Docker Hub is the target container image +registry to use when creating the pull secret. + +#### Kubernetes Namespace Selection Strategy +The operator needs to know which WebLogic domains in the Kubernetes cluster that it will manage. It does this at the +Kubernetes namespace level, so any WebLogic domain in a Kubernetes namespace the operator is configured to manage, will +be managed by the operator instance being installed. Use the `Kubernetes Namespace Selection Strategy` field to choose +the desired namespace selection strategy from one of the supported values: + +- `Label Selector` (default) - Any Kubernetes namespace with a specified label will be managed by this operator. +- `List` - Any Kubernetes namespace in the provided list will be managed by this operator. +- `Regular Expression` - Any Kubernetes namespace whose name matches the provided regular expression will be managed + by this operator. +- `Dedicated` - Only the Kubernetes namespace where the operator is installed will be managed by this operator. + +_**Note** that the operator Helm chart default is `List` but the application overrides this to specify `Label Selector` as +the default value._ + +Each namespace selection strategy takes different input values; the form fields will change based on the strategy +selected: + +- When using the `Label Selector` strategy, the `Kubernetes Namespace Label Selector` field will appear with a default +value that aligns with the Helm chart default value. +- The `Regular Expression` strategy uses the required +`Kubernetes Namespaces Regular Expression` field to specify the regular expression to use for matching the Kubernetes +namespaces that the operator should manage. +- Selecting the `List` strategy will cause the `Kubernetes Namespaces to Manage` field to appear with a list containing +the `default` namespace; this aligns with the default value in the Helm chart. + - Removing the `default` namespace is fine and will result in an empty list. + - Note that when deploying the domain with an operator using the `List` strategy, the +application will automatically add the new domain's Kubernetes namespace to the list specified list, if needed. As +such, specifying an empty list will not prevent your WebLogic domain from being managed by the operator. +- `Dedicated` is self-defining so no additional fields are necessary. + +#### WebLogic Kubernetes Operator Role Bindings +When installing the operator, the operator Helm chart default is to create a Kubernetes Role and a Kubernetes RoleBinding +in each Kubernetes namespace being managed by the operator. By enabling `Enable Cluster Role Binding`, the +operator installation will create a Kubernetes ClusterRole and ClusterRoleBinding that the operator will use for all managed +namespaces. This ClusterRole and ClusterRoleBinding will be shared across all operator installations in the Kubernetes +cluster (assuming that those installations also enable cluster role binding). + +Using the default namespace-specific roles and role bindings, the administrator follows the Principle of Least +Privilege to guarantee that the operator cannot perform any actions on other, non-managed namespaces. The implication +of this configuration is that because the operator service account does not have permission to create roles and role +bindings, any new namespace added for the operator to manage does not have the necessary role and role binding needed +for the operator to manage the namespace. Rerunning the operator Helm chart with the operator configured to manage the +new namespaces will cause the Helm chart to create the necessary Role and RoleBinding objects in each namespace, +as needed. + +If the operator is using the ClusterRole and ClusterRoleBinding, then the new namespaces will be automatically picked up by +the operator when using either the `Label Selector` or `Regular Expression` namespace selection strategy without any +need to rerun the operator Helm chart. + +As previously mentioned, the WKT UI application automatically reruns the operator Helm chart when deploying new WebLogic +domains to ensure that the new domain's namespace is being managed by the operator. + +#### External REST API Access +By default, the operator's REST API is not exposed outside the Kubernetes cluster. To enable the REST API to be +exposed, enable `Expose REST API Externally`, set the desired HTTPS port using the +`External REST API HTTPS Port` field, and name of the Kubernetes TLS secret to use in the +`External REST API Identity Secret Name` field. For more information, see the WebLogic Kubernetes Operator +[Rest API](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-operators/the-rest-api/) documentation. + +#### Third Party Integrations +To enable integration with the Elasticsearch, Logstash, and Kibana (ELK) stack, enable `ELK Integration Enabled` and provide values for the +following fields. + +- `Logstash Image Tag to Use` - The container image of `logstash` to use. +- `Elasticsearch Host Name` - The DNS name of IP address of the Elasticsearch server. +- `Elasticsearch Port` - The port number for the Elasticsearch server. + +For more information, see [Elastic Stack integration](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-operators/#optional-elastic-stack-elasticsearch-logstash-and-kibana-integration) +in the WebLogic Kubernetes Operator documentation. + +#### Java Logging +This pane lets you override the operator's Java logging configuration, which can be useful when debugging issues +with the operator. Use the `Logging Level` field to customize the minimum log level written to the log file. The +`Log File Size Limit` field sets the maximum size of a single operator log file while the `Log File Count` limits the +maximum number of retained log files. For more information, see +[Operator Helm configuration values](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-operators/using-helm/#operator-helm-configuration-values) +in the WebLogic Kubernetes Operator documentation. + +### Code View +The `WebLogic Operator` page's `Code View` displays a shell script that you can use as a starting point for automating the +operator installation process. + +If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note +that the application is providing a working sample script to show how the process might be automated. Before +using the script, review the script and make any changes necessary for your environment. One typical change that +would be considered a best practice would be to change the script to accept either command-line arguments or externally +set environment variables to specify any credentials required by the script to eliminate hard-coding the credentials in +the script itself. This change is left as an exercise for you because different environments typically will have +existing standards for securely handling such credentials. + +### Install Operator +`Install Operator` installs the WebLogic Kubernetes Operator in the target Kubernetes cluster. +You access this action by using the `Install Operator` button on the +`WebLogic Operator` page or the `Go` > `Install WebLogic Kubernetes Operator` menu item. + +At a high level, `Install Operator` performs the following steps: + +1. Validates the input values necessary for running the action based on your selections. +2. Saves the WKT Project, if needed. +3. Creates the Kubernetes namespace for installing the operator, if needed. +4. Creates the Kubernetes service account for the operator to use, if needed. +5. Creates the operator image pull secret, if needed. +6. Adds the latest operator Helm chart to the local Helm repository. +7. Runs Helm to install the operator using the specified configuration. + +### Update Operator + +`Update Operator` updates the settings on a running WebLogic Kubernetes Operator by using the `helm upgrade` command. +You access this action by using the `Update Operator` button on the +`WebLogic Operator` page or the `Go` > `Update WebLogic Kubernetes Operator` menu item. + +`Update Operator` applies all the changes to the operator that you have specified on the page. For example, +you can change the operator image version, the domain namespace selection strategy, Java logging level, +or the value of any field in the WebLogic Kubernetes Operator section. + +### Uninstall Operator + +`Uninstall Operator` uses the `helm uninstall` command to remove the WebLogic Kubernetes Operator and its associated +resources from the Kubernetes cluster. In addition, you can choose whether to also delete the corresponding namespace. +You access these actions by using the `Uninstall Operator` button on the +`WebLogic Operator` page or the `Go` > `Uninstall WebLogic Kubernetes Operator` menu item. + +Note that if you uninstall an operator, then any domains that it is managing will continue running; however, +any changes to a domain resource that was managed by the operator will not be detected or automatically handled, +and, if you want to clean up such a domain, then you will need to manually delete all of the domain's resources (domain, pods, services, and such). diff --git a/documentation/staging/1.2/content/navigate/model.md b/documentation/staging/1.2/content/navigate/model.md new file mode 100644 index 000000000..edfbf1466 --- /dev/null +++ b/documentation/staging/1.2/content/navigate/model.md @@ -0,0 +1,178 @@ +--- +title: "Model" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 2 +--- + + +### Contents +- [Model](#model) +- [Design View](#design-view) +- [Code View](#code-view) + - [Model Editor](#model-editor) + - [Variables Editor](#variables-editor) + - [Archive Editor](#archive-editor) +- [Validate Model](#validate-model) +- [Prepare Model](#prepare-model) + + +### Model +The `Model` section helps you work with WebLogic Deploy Tooling models for a WebLogic domain. A WebLogic +Deploy Tooling model for a domain can include the following file types: + +- Model file - A declarative definition of the domain configuration. +- Variable file - A property file that maps names to values. These names can be referenced from the model file to + allow a model to be used across environments by applying the variable file for a particular environment to the model. +- Archive file - A ZIP file containing application binaries and other files and directories needed to run the domain. + +For more information about WebLogic Deploy Tooling models, see [Metadata Model](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/) +and [Archive File](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/) in the WebLogic Deploy +Tooling documentation. + +### Design View +In the current release, the `Design View` is empty. Our intention is to eventually provide a WebLogic +console-like set of pages that will make it easier to create or edit a model using an interface more familiar to +WebLogic administrators and developers. + +### Code View +Using an IDE-like layout, the `Code View` provides editor panes for editing the model, variables, and archive files, +each of which support creating and editing the domain's WDT files. When working with an editor, there are several things +to keep in mind: + +- When working with a WKT Project that has no associated WDT file for storing the data, entering data into an editor + will cause a new WDT file with the editor's current content to be created and associated with the project. +- Changes made in the editor are buffered in memory until the WKT Project is saved. +- Adding, deleting, or modifying data in the variable or archive editors will _not_ change the model references. You + will need to make sure that the model references are accurate and up to date. + +While it is possible to use the WKT UI application to create the files from scratch, the `File > Add Model` +menu supports adding existing files or using the WebLogic Deploy Tooling's +[Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) +to create a model of an existing domain. + +{{% notice note %}} +While WebLogic Deploy Tooling supports using multiple model, variables, or archive files to describe a single +domain, the current release of WKT supports _only_ one WDT model file, one WDT variables file, and one WDT archive file for +describing the domain. +{{% /notice %}} + +#### Model Editor +In `Code View`, the model editor is just to the right of the navigation pane. This editor displays the current +model file associated with the WKT Project file. Typing model content into the editor will +result in a new model file being added to the project the next time the project is saved. + +The current release has the following limitations: + +- Model files must be in YAML format. +- Model files must exist directly on the file system and not inside an archive, such as in a ZIP file; any model file inside an archive is ignored by the application. + +#### Variables Editor +The WDT variables editor is in the upper right pane of the `Code View` page. It supports editing any existing +name-value pairs, as well as adding or removing name-value pairs. + +To reference a variable from the model, you must set the value of the desired model file to a variable reference. +For example, the model snippet shown here references a variable named `httpPort`. + +```yaml +topology: + Name: tododomain + ProductionModeEnabled: true + Cluster: + mycluster: + DynamicServers: + ServerNamePrefix: Server_ + DynamicClusterSize: 10 + ServerTemplate: mysrvtemplate + ServerTemplate: + mysrvtemplate: + ListenPort: '@@PROP:httpPort@@' + Cluster: mycluster + +``` + +When working with this model file, WebLogic Deploy Tooling expects the `httpPort` variable to be defined in the model's +variables file, as shown here: + +```properties +httpPort = 7001 +``` + +#### Archive Editor +The WDT archive editor is in the lower right pane of the `Code View` page. It supports adding content to and +removing content from the archive file. While updating content in the archive is not supported directly by the archive +editor, the archive editor safely supports multiple operations on the same entry. As such, combining a +`remove` operation followed by the corresponding `add` operation will effectively replace an entry. + +To add content to the archive file, use the plus (`+`) button in the archive editor +title bar and follow the prompts to choose the type of content to add and select the corresponding file or directory. +For example, to add a WAR file called `todo.war` to the archive, do the following: + +1. On the archive editor title bar, click `+`. +2. In the resulting dialog, choose `Application File` from the list and click `OK`. +3. In the resulting file chooser dialog, select the `todo.war` file and click `Select`. + +This will result in the file structure `wlsdeploy/applications/todo.war` being added to the archive editor pane. +At this point, the application has not created or modified the archive file; it is simply storing +the data it needs about the archive path to the added entry and the file path where the content is found. Saving the +WKT Project will update the archive to reflect the buffered operations performed in the editor. + +{{% notice note %}} +Don't forget to add the application to the model and set its `SourcePath` attribute to the path in the archive where it can be found, +as shown in the following model file snippet. +{{% /notice %}} + +```yaml +appDeployments: + Application: + todo: + SourcePath: wlsdeploy/applications/todo.war + ModuleType: war + Target: mycluster +``` + +To remove content from the archive file, select the content to remove in the archive editor pane and click the minus (`-`) +button in the archive editor title bar. _Don't forget to remove any reference to this content from the model file._ + +#### Validate Model +`Validate Model` invokes the WDT [Validate Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/validate/), +which validates that the model and its related artifacts are well-formed and provides help on the valid attributes and subfolders +for a particular model location. This action is available by using the `Validate Model` button on the `Model` page and by selecting +`Go` > `Validate Model Files`. + +#### Prepare Model +`Prepare Model` invokes the WDT [Prepare Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/prepare/) +to modify the model to work in a Kubernetes cluster with WebLogic Kubernetes Operator or Verrazzano installed. This +action is available by using the `Prepare Model` button on the `Model` and `Kubernetes WebLogic Domain` pages and by selecting +`Go` > `Prepare Model for Kubernetes`. It is also possible to run `Prepare Model` during the `Create +Image` action, though typically it is best to run `Prepare Model` explicitly, prior to moving to the `Image` section. + + +`Prepare Model` does the following: + +1. Removes model sections and fields that are not compatible with the target environment. +2. Replaces endpoint values with model tokens that reference variables. +3. Replaces credential values with model tokens that reference either a field in a Kubernetes secret or a variable. +4. Provides default values for fields displayed in the application's variable, variable overrides, and secret editors. +5. Extracts topology information to the application that it uses to generate the resource file used to deploy the domain. + +For more information, see the WDT [model tokens](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#model-tokens) +documentation. + +In replacing credential values, `Prepare Model` must handle the replacement differently for the "Domain in Image" and +"Model in Image" [domain locations]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}): + +- With "Domain in Image", the WebLogic Image Tool creates the domain while creating the image. As such, it has no +knowledge of Kubernetes so the token replacement uses variable tokens so that domain creation has access to the actual +credential values. You must ensure that all variables have valid values prior to running `Create Primary Image`. + +- For "Model in Image", the domain is created at runtime by the WebLogic Kubernetes Operator running in a Kubernetes +cluster. As such, token replacement uses secret tokens for all credential fields. You must to be sure to provide +values for all secret reference fields using the `WebLogic Domain` section's `Secrets` pane so that the required secrets +get populated correctly during domain deployment. For more information, see [WebLogic Domain]({{< relref "/navigate/kubernetes/k8s-weblogic-domain.md" >}}). + +{{% notice note %}} +The application tries to preserve any values from the model and variable files that `Prepare Model` replaces +with secret tokens. The current release is limited by the behavior of the underlying WDT Prepare Model Tool in that +all passwords are not retained and must be re-entered in the appropriate location. +{{% /notice %}} diff --git a/documentation/staging/1.2/content/navigate/project-settings.md b/documentation/staging/1.2/content/navigate/project-settings.md new file mode 100644 index 000000000..f723ab7e6 --- /dev/null +++ b/documentation/staging/1.2/content/navigate/project-settings.md @@ -0,0 +1,122 @@ +--- +title: "Project Settings" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 1 +--- + +The first stop for every new project is `Project Settings`. In this section, you make decisions and provide +input for the project on: + +- [Credential Storage](#choosing-a-credential-storage-scheme) +- [Domain Location](#choosing-a-domain-location) +- [Kubernetes Environment Target Type](#choosing-a-kubernetes-environment-target-type) +- [JDK and WebLogic Server Installation Directories](#choosing-the-java-and-oracle-installation-directories) +- [Image Build Tool Type and Executable Location](#choosing-the-image-build-tool) + +When running the WKT UI application on Windows or Linux, the application inherits its environment from the user. For example, +adding a directory to the PATH used by the application is just a matter of changing your +PATH environment variable and restarting the application. On macOS, things are a bit more complicated. + +When running the application on macOS, the application inherits the environment of a daemon process called `launchd` instead +of your environment. By default, the `launchd` environment contains only a few core directories on the `PATH` +(that is, `/usr/bin`, `/bin`, `/usr/sbin`, and `/sbin`). This will, for example, cause `kubectl` invocations requiring +access to one of the cloud providers' command-line tooling to fail if the tool is not found in one of those locations. +While it is possible for an administrative user to change the environment that `launchd` uses to address this issue, the +WKT UI application provides the `Extra Path Directory` table to explicitly add the directory where the cloud providers' +command-line tooling is installed, to the `PATH` that the application uses to invoke `docker`, `podman`, `kubectl`, and +`helm`. Also, use the `Extra Environment Variable Name/Extra Environment Variable Value` table to define extra +environment variables as needed. Note that this extra environment configuration is used _only_ when invoking +Docker/Podman, kubectl, and Helm. This section is visible only when running the application on macOS. + + +#### Choosing a Credential Storage Scheme +The WKT UI application can securely store credentials for your project or not store them at all. The three choices +are: + +- Use the Native OS Credential Store +- Store Encrypted Credentials in the WKT Project File +- Not Store Credentials + +If you choose `Store in Native OS Credential Store`, then you will be using the Windows Credential Manager, the macOS Keychain, +or the Linux `libsecret` library's credential store. These credential stores offer a well-known, secure mechanism for +storing credentials that most users already understand. The only downside to this scheme is that the credentials are +stored only on the local machine. Anyone trying to share their project with others users will have to have the other users +re-enter the credentials so that they get saved to their local machine's credential store. + +{{% notice note %}} +The WKT UI application can require storing a dozen or more credentials, depending on your WebLogic Server +domain configuration. Upon first access by the WKT UI to load credentials from the credential store, the OS will prompt +whether you want to allow the application access to each credential, prompting you once for each credential. This +can get annoying, but on some platforms (for example, macOS), you have the option of telling the OS to always allow access to +the credential by the WKT UI application. +{{% /notice %}} + +The other choice to store credentials, `Store Encrypted in Project File`, uses a passphrase-based encryption built into the application that allows +the credentials to be stored inline in the WKT Project file. The algorithms and techniques used follow the current +industry standards and recommendations; however, because this project is open source, you can look at the details, +if you are interested. The only downside to this approach is that, because the passphrase itself is +never stored, you must share the passphrase with any other users that should be able to use the WKT Project file. + +A creative person might realize that they can use the passphrase-based encryption to move credentials normally stored +in the native OS credential store to another machine. The steps to accomplish this would be: + +1. Open the project using the native OS credential store on the machine where the credentials are stored. +2. Change the credential storage option to passphrase-based encryption and enter a passphrase. +3. Save the project file. +4. Open the project file on a different machine, supplying the passphrase entered in step 2. +5. Change the credential storage option to native OS credential store. +6. Save the project file. + +The final choice, `Not Stored`, is to not store the credentials at all. While this is a viable option, it also means that whenever you +need to run any of the actions that require credentials, you will need to re-enter the value of every credential in the +project. + +#### Choosing a Domain Location +When getting started with a new WKT Project, one of the first things to consider is where you want the domain to reside. +Domains can reside in a container, in an image, or in a persistent volume. Your choice will expose and hide different +fields across most sections of the UI. The following describe the implications of the three locations: + +- `Created in the container from the model in the image` - The newest and most popular location for a domain is in the container. This is known as "Model in Image" but also +referred to as a "From Model" in the underlying WKT tooling. In this case, the set of model-related files are added to +the image. When the WebLogic Kubernetes Operator domain object is deployed, its inspector process runs and creates the +WebLogic Server domain inside a running container on-the-fly. While this process adds a small amount of overhead at +startup, it also makes it easier to maintain the image. For example, you can have a common WebLogic Server image that +is updated periodically to pick up the latest Patch Set Updates (PSUs). Then, you use that image to add the +most recent version of the WebLogic Deploy Tooling and your domain model files as a layer on top. + +- `Created as part of the image` - This selection stores the domain in the image. This is known as "Domain in Image" but also is referred to as "Image" +in the WebLogic Kubernetes Operator configuration. Using this option, the domain is created from the model by the +WebLogic Image Tool (using the WebLogic Deploy Tooling) and baked into the image. While this saves a little overhead +at startup, it is more expensive to maintain due to the need to recreate the domain every time a new WebLogic +Server image is created. + +- `Externally created in a Kubernetes persistent volume` - This selection stores the domain in a Kubernetes persistent volume; this is known as "Domain in PV". +This closely approximates the traditional way of maintaining a domain where the domain is created on disk and then +used and maintained for as long as necessary. Depending on which Fusion Middleware products you are using, this may be +your only supported choice for running the domain in Kubernetes. The WKT UI application currently doesn't do anything to help +you create the persistent volume, the necessary persistent volume claim, or the domain. After those things exist, the +application will allow you to use them to deploy new domains stored in a persistent volume. + +##### Choosing a Kubernetes Environment Target Type +The target type tells the application what sort of Kubernetes environment that you plan to use. Currently, `WebLogic +Kubernetes Operator` and `Verrazzano` are the only two choices. The application uses the target type to: + +- Tell WDT how to prepare the model for deployment. +- Determine what sections and their associated actions within the application, to display. + +For example, the `Kubernetes` pages are relevant to the WebLogic Kubernetes Operator target type, so those pages +and their associated actions are hidden when the Verrazzano target type is selected; instead, the `Verrazzano` +pages are displayed. Note that in the current release, Verrazzano support is limited to the `Model` and `Image` sections. + +#### Choosing the Java and Oracle Installation Directories +The application uses these directories when invoking the WebLogic Deploy Tooling and WebLogic Image Tool; it does not +use them for any other purpose. When selecting these directories, make sure to select the same directory you would use +to set the `JAVA_HOME` and `ORACLE_HOME` (or `MW_HOME`) environment variables. These are generally the top-level +installation directories. + +#### Choosing the Image Build Tool +To build new images, inspect images, and interact with image repositories, the WKT UI application uses an image build +tool, which defaults to `docker`. The image build tool must be installed locally, as mentioned in the [Prerequisites]({{< relref "/setup/prerequisites.md" >}}). +While `docker` is currently the most popular tool, many vendors (for example, Oracle, IBM RedHat, Google) are moving to +use `podman` by default. diff --git a/documentation/staging/1.2/content/navigate/verrazzano.md b/documentation/staging/1.2/content/navigate/verrazzano.md new file mode 100644 index 000000000..81e6a49cf --- /dev/null +++ b/documentation/staging/1.2/content/navigate/verrazzano.md @@ -0,0 +1,11 @@ +--- +title: "Verrazzano" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 6 +--- + + + +In the current release, this is a placeholder for pages that will provide similar functionality to the Kubernetes +section when using Verrazzano. diff --git a/documentation/staging/1.2/content/release/_index.md b/documentation/staging/1.2/content/release/_index.md new file mode 100644 index 000000000..534fbff7a --- /dev/null +++ b/documentation/staging/1.2/content/release/_index.md @@ -0,0 +1,64 @@ ++++ +title = "Release Notes" +date = 2022-01-30T12:48:00-05:00 +weight = 5 +pre = " " ++++ + +### Changes in Release 1.1.1 +- [Major New Features](#major-new-features) +- [Other Changes](#other-changes) +- [Bugs Fixes](#bug-fixes) +- [Known Issues](#known-issues) + +#### Major New Features +No new features. + +#### Other Changes +- Revamped the Ingress Route editing mechanism: + - Added busy dialog while fetching existing service data from the domain's Kubernetes namespace prior to opening the route edit dialog. + - Added placeholders to the `Target Service` and `Target Port` fields to clarify the current state of these fields when no value is selected. + - Added logic to reset the `Target Port` field selection when the `Target Service` field changes and the selected port is not valid for the new service selected. +- Reworked the Image page and related fields on the Domain page to improve usability. With these changes, a user not needing to create new images can bypass the Image page completely. + - Converted `Use Auxiliary Image` and `Create New Auxiliary Image` switches to radio buttons to make the three options more clear. + - Moved the `Image Tag` and `Image Registry Address` fields from the Image page tabs to the Domain page when not creating a new image. + - Replicated the `Create New Primary Image` and `Auxiliary Image Configuration` controls from the Image page to the Domain page. + - Added navigation buttons on the Domain page to direct the user to go back to the Image page when creating a new image. +- Bundled WebLogic Deploy Tooling 2.1.0. See [WDT release notes](https://github.com/oracle/weblogic-deploy-tooling/releases/tag/release-2.1.0) for details. +- Reworked Model actions to work better for `Domain in Image` and `Domain in PV` use cases. + - Enhanced Prepare Model action to use the new target types added in WebLogic Deploy Tooling 2.1.0 so that Prepare Model works properly for `Model in Image`, `Domain in Image`, and `Domain in PV` use cases. + - Removed `Domain in PV` check that was previously preventing both `Validate Model` and `Prepare Model` actions from being used. +- Enhanced Domain page `Cluster` table to be editable when using `Domain in PV` to support use cases where the project has or doesn't have a model. +- Converted all `aria-label` fields to use the i18n resource bundle. +- Removed `webui` unit tests from the installers. + +#### Bug Fixes +- Resolved issue with "Save As" when saving project file in a different directory. +- Resolved issue with "Save As" where the project was losing an entry for the archive file if no pending changes exist. +- Resolved issue where project file to window mapping was causing unnecessary reassigning of the credential manager. +- Added additional RPM installer dependencies to try to resolve installation issues when on a Linux VM not being used as a desktop machine. +- Added a native macOS ICNS icon to resolve mangled icon on macOS. +- Resolved issue with existing ingress route detection to eliminate overwrite warnings when route does not exist. + +### Known Issues + +- When running the WKT UI application on Windows, the image builder tool (Docker or Podman) also must be directly + executable in Windows. For example, there is currently no support for running the WKT UI application in Windows and + running Podman under the Windows Subsystem for Linux (WSL2). However, running Docker Desktop for Windows with a WSL2 + backend _is_ fully supported because the `docker` command is executable directly in Windows (without having to call + WSL2). If you need to use Podman on Windows, then refer to the Podman blog entries at + https://podman.io/blogs/2021/09/06/podman-on-macs.html and https://podman.io/blogs/2020/09/02/running_windows_or_mac.html + for more information about downloading, installing, and configuring the Windows Remote Client. + +- On Linux, the application depends on libGL being installed. libGL is not currently listed in the dependencies list + for the `rpm` (or `deb`) installers. Therefore, you will need to install libGL using your package manager. + For example: + ``` + sudo yum install libGL + ``` + +- When trying to run the application on a Linux machine and display it on a Windows machine, do not use the Xming X + server. There appears to be a bug (presumably with their OpenGL support) that prevents applications using Electron + 13.x or later from working (for example, Microsoft VS Code doesn't work either). + +- The application is limited to working with archive files whose size is less than 2 GB. diff --git a/documentation/staging/1.2/content/release/release-1.1.0.md b/documentation/staging/1.2/content/release/release-1.1.0.md new file mode 100644 index 000000000..ca477b1e9 --- /dev/null +++ b/documentation/staging/1.2/content/release/release-1.1.0.md @@ -0,0 +1,81 @@ +--- +title: "Release 1.1.0" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 2 +description: "Install the WKT UI application and check for updates." +--- + +### Changes in Release 1.1.0 +- [Major New Features](#major-new-features) +- [Other Changes](#other-changes) +- [Bugs Fixes](#bug-fixes) +- [Known Issues](#known-issues) + + +#### Major New Features +- Updated macOS environment control to specify extra environment settings to pass down to Docker/Podman, kubectl, and Helm invocations. +- Bundling WebLogic Deploy Tooling 2.0.0. See [WDT release notes](https://github.com/oracle/weblogic-deploy-tooling/releases/tag/release-2.0.0) for details. +- New Validate Model action that leverages WDT 2.0 changes to validate the model files and reports any validation errors it finds. +- Updated Prepare Model action that leverages WDT 2.0 changes to improve model preparation for deploying with WebLogic Kubernetes Operator. +- Added support for splitting the FMW (WebLogic or FMW Infrastructure) and WDT model images (also known as auxiliary images). + - New Create Auxiliary Image action to create an auxiliary image. + - New Push Auxiliary Image action to push an auxiliary image to an image registry. +- New Update Operator action to apply changes such as a version upgrade to an existing WebLogic Kubernetes Operator installation. +- New Uninstall Operator action to uninstall the WebLogic Kubernetes Operator installation and optionally, its Kubernetes namespace. +- New Undeploy Domain action to undeploy an existing domain and optionally, its Kubernetes namespace. +- New Uninstall Ingress Controller action to uninstall the ingress controller installation and optionally, its Kubernetes namespace. +- Updated Ingress Route editing to improve control for SSL and provide lists of available target services and target ports. + +#### Other Changes +- Added the `Save As` menu item to allowing saving a project and any model files to a new name/location. +- Improved Internet connectivity check mechanism and added configurable timeout settings to address issues some users were + having with the default OCI DNS settings causing extra long DNS name resolution times that were triggering the hard-coded timeout. +- Upgraded Electron to version 16. +- Upgraded the Model Code View page's embedded ACE editor to 1.4.13. +- Relocated the older, macOS-specific `Extra Path Directories` functionality from the Kubernetes Client Configuration page to the + Project Settings page to better align with new macOS environment settings and the scope to which they apply. +- Replaced `Help` menu's `Visit Website` menu item with a `View Documentation` menu item that opens the WebLogic Kubernetes Toolkit UI + documentation in the user's browser. +- Added a result dialog to display the Primary Image's custom base image's content found by the Inspect Image action. +- Added a warning message to the Discover Model action if the project has existing model files that will be overwritten by the action. +- Changed the Windows and Linux About dialog to not be modal. +- Added `Application Deployment Plan`, `Custom File`, and `Custom Directory` option types to the Archive editor's Add dialog. + +#### Bug Fixes +- Resolved macOS-specific issue with `Quit WebLogic Kubernetes Toolkit UI` where it required invoking it multiple times + to exit the application. +- Resolved macOS-specific issue where `Quit WebLogic Kubernetes Toolkit UI` was not working if the About dialog window + was the last window open. +- Resolved application update dialog issue where the Release Notes link was not opening in the user's browser. +- Resolved all known issues with application update functionality on all platforms. +- Resolved Podman-related issues to pass key environment variables down to all `podman` executions. +- Resolved Podman-related issue with pushing to Docker Hub. +- Resolved issues with the Primary Image tab's Inspect Image button. +- Resolved issue with Prepare Model action's secret handling whereby domain secret values were being lost. +- Resolved an issue where double-clicking on an action button was causing multiple actions to run simultaneously. +- Worked around macOS-specific Electron issue that caused the model editor to not receive a blur event when using the + application menus. + +#### Known Issues + +- When running the WKT UI application on Windows, the image builder tool (Docker or Podman) also must be directly + executable in Windows. For example, there is currently no support for running the WKT UI application in Windows and + running Podman under the Windows Subsystem for Linux (WSL2). However, running Docker Desktop for Windows with a WSL2 + backend _is_ fully supported because the `docker` command is executable directly in Windows (without having to call + WSL2). If you need to use Podman on Windows, then refer to the Podman blog entries at + https://podman.io/blogs/2021/09/06/podman-on-macs.html and https://podman.io/blogs/2020/09/02/running_windows_or_mac.html + for more information about downloading, installing, and configuring the Windows Remote Client. + +- On Linux, the application depends on libGL being installed. libGL is not currently listed in the dependencies list + for the `rpm` (or `deb`) installers. Therefore, you will need to install libGL using your package manager. + For example: + ``` + sudo yum install libGL + ``` + +- When trying to run the application on a Linux machine and display it on a Windows machine, do not use the Xming X + server. There appears to be a bug (presumably with their OpenGL support) that prevents applications using Electron + 13.x or later from working (for example, Microsoft VS Code doesn't work either). + +- The application is limited to working with archive files whose size is less than 2 GB. diff --git a/documentation/staging/1.2/content/setup/_index.md b/documentation/staging/1.2/content/setup/_index.md new file mode 100644 index 000000000..9cdf77d6a --- /dev/null +++ b/documentation/staging/1.2/content/setup/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Get Started" +date = 2019-02-22T15:27:38-05:00 +weight = 2 +pre = " " ++++ + +{{% children style="h4" description="true" %}} diff --git a/documentation/staging/1.2/content/setup/install.md b/documentation/staging/1.2/content/setup/install.md new file mode 100644 index 000000000..37ad8b12f --- /dev/null +++ b/documentation/staging/1.2/content/setup/install.md @@ -0,0 +1,80 @@ +--- +title: "Install WKT UI" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 2 +description: "Install the WKT UI application and check for updates." +--- + +1. Download the latest WebLogic Kubernetes Toolkit UI (WKT UI) application installers from the [GitHub Releases section](https://github.com/oracle/weblogic-toolkit-ui/releases) of this repository. +2. Simply run the appropriate installer for your operating system. + + +**NOTE**: On Linux, to get _all_ the dependencies and have them installed in the correct order, you need to use the package manager to install the `rpm` or `deb` file. First, be sure to review the Linux prerequisites [here]({{< relref "/setup/prerequisites.md" >}}). + +- For RPM-based systems, use either `yum` or `dnf`; for example: + ``` + yum update + sudo yum -y localinstall wktui_1.0.0_amd64.rpm + ``` + +- For Debian-based systems, use: + ``` + sudo apt update + sudo apt upgrade + sudo apt install ./wktui_1.0.0_amd64.deb + ``` + +If the installation is on a server machine, you should `logout` from the current terminal session and use X11 forwarding mechanism or any remote desktop application to the remote terminal for launching the WKT UI application. + +Alternatively, you can download the `AppImage` file, copy it to your local file system, then either: +- Open a terminal, navigate to the directory where the file exists, and make it executable; for example: + + `chmod u+x ` + +- Use your file manager, right click on the file, edit the properties, and change the permissions to make it executable. + +If you download and run the `AppImage` file, you get the added benefits of 1.) Not requiring an installation or root access and 2.) Being able to participate in the auto-update functionality, like macOS and Windows. + +#### Helpful Hints + +- When launching the WKT UI application, if you see this: + ``` + libGL error: No matching fbConfigs or visuals found + libGL error: failed to load driver: swrast + ``` + This is harmless and can be removed by setting the environment variable: + + `export LIBGL_ALWAYS_INDIRECT=1` + + +- If you are storing credentials in the OS native store, and you see this failure message: + ``` + Error occurred in handler for 'save-project': Error: Failed to save credential for image. + imageRegistryPushUser: Error: No such interface "org.freedesktop.Secret.Collection" on object at path / + org/freedesktop/secrets/collection/login + at /tmp/.mount_WebLogpIPFto/resources/app.asar/app/js/credentialManager.js:92:32 + ``` + You can solve it by running this command (only once) before launching the WKT UI application: + + `dbus-update-activation-environment --systemd DBUS_SESSION_BUS_ADDRESS DISPLAY XAUTHORITY` + +### Application Startup + +Application startup detects Internet connectivity to GitHub. If it fails to connect, a `Network Configuration` dialog appears in which you can set or modify your proxy settings, test your changes, and then restart the application. + +Launching the application displays a thorough "Introduction" to the WKT UI. Step through it or dismiss it; you can peruse it at any time using `Help > Show Introduction`. + +### Version Updates + +Upon application startup, if a more recent version exists, an Application Update dialog appears with these choices: + +- `Install Now` +- `Install on Exit` + - Downloads the application and installs it after you exit. + - Not available on macOS. +- `Ignore Update` + +At any time, you can check for application updates using `Help > Check for WKT UI Updates`. + +For updates to in-application versions of WKT Tools (WebLogic Deploy Tooling and WebLogic Image Tool), select `Help > Check for WKT Tool Updates`. diff --git a/documentation/staging/1.2/content/setup/prerequisites.md b/documentation/staging/1.2/content/setup/prerequisites.md new file mode 100644 index 000000000..03f3d3eb1 --- /dev/null +++ b/documentation/staging/1.2/content/setup/prerequisites.md @@ -0,0 +1,72 @@ +--- +title: "Prerequisites" +date: 2019-02-22T15:44:42-05:00 +draft: false +weight: 1 +description: "Install the prerequisite requirements." +--- + + +WebLogic Kubernetes Toolkit UI has a number of prerequisites that must be installed locally to fully use the +WKT UI application functionality. + +These include: + +- Java Development Kit (JDK) - Required by both WebLogic Deploy Tooling and WebLogic Image Tool. + Install a JDK version that is compatible with your local WebLogic Server installation. +- WebLogic Server (WLS) - Required by WebLogic Deploy Tooling. Install a WebLogic Server version + 12.2.1.3.0 or later; it is a best practice to install the latest Patch Set Updates (PSUs) and other recommended patches. The + application uses WebLogic Server to gain access to the WebLogic Server Scripting Tool (WLST) and other related artifacts to use + as a client. +- `docker` (or `podman`) - Required to create images locally and interact with image registries. +- `kubectl` - Required to interact with your Kubernetes cluster. Install a version that is + compatible with your Kubernetes cluster version. For more information, see the Kubernetes `Client Configuration` page in the UI. +- Cloud Provider's Command-Line Interface (CLI) tool - If your Kubernetes cluster is running in one of the cloud + provider's managed Kubernetes services, then you will need to download and install the cloud provider's CLI. This is + typically required to configure `kubectl` to properly authenticate to the Kubernetes cluster. Again, see the Kubernetes + `Client Configuration` page for more information about configuring `kubectl` to work with your cluster. +- `helm` - Helm version 3.3.2 or later. Required to install the WebLogic Kubernetes Operator and to install an ingress controller. +- `openssl` - Used to generate an X.509 TLS certificate for ingress routes, should you ask the application + to generate one for you. + +{{% notice note %}} The WKT UI application is built using the Electron framework and as such, we support only the platforms and versions supported by [Electron](https://www.electronjs.org/docs/latest/tutorial/support#supported-platforms). For example, because of the Electron requirement for Fedora 24 or newer, we support _only_ versions 8.0 and higher of Oracle Linux, RedHat Linux, and CentOS Linux. +{{% /notice %}} + +In addition to these local software dependencies, you will need a Kubernetes cluster to which you can deploy your +containerized WebLogic Server domain and its applications. If you do not already have a model, then you can either write +one by hand using the WKT UI application or discover the model from an existing domain. Most likely, you'll want to start +with a WebLogic domain that can be used to discover the model from the domain. + +#### Linux Prerequisites + +- For RPM-based systems, such as Oracle, RedHat, CentOS, and some others: + + - For storing credentials in the OS native credentials store, you must have a desktop environment. If your system does not have a graphical desktop environment, then you can install one; for example, installing GNOME Desktop on Oracle Linux: + + https://support.oracle.com/knowledge/Oracle%20Linux%20and%20Virtualization/2717454_1.html + + - For running the WKT UI on a remote machine without desktop environment and accessing it through X forwarding, you need to ensure X forwarding is working properly. For example, + + ``` + sudo dnf install xterm + logout + ssh -X ... + xterm + ``` + +- For Debian-based systems, such as Ubuntu and Debian: + + - For storing credentials in the OS native credentials store, you must have a desktop environment. If your system does not have a graphical desktop environment, then you can install one; for example, installing GNOME on Ubuntu 20x: + ``` + sudo apt install gnome-session gdm3 + sudo reboot + ``` + + - For running the WKT UI on a remote machine without desktop environment and accessing it through X forwarding, you need to ensure X forwarding is working properly. For example, + + ``` + sudo apt install xterm + logout + ssh -X ... + xterm + ``` diff --git a/documentation/staging/1.2/layouts/shortcodes/img.html b/documentation/staging/1.2/layouts/shortcodes/img.html new file mode 100644 index 000000000..bcf298bcc --- /dev/null +++ b/documentation/staging/1.2/layouts/shortcodes/img.html @@ -0,0 +1 @@ +{{ .Get 0 }} \ No newline at end of file diff --git a/documentation/staging/1.2/runlocal.sh b/documentation/staging/1.2/runlocal.sh new file mode 100755 index 000000000..a09259d2f --- /dev/null +++ b/documentation/staging/1.2/runlocal.sh @@ -0,0 +1,9 @@ +#!/bin/bash +# +# Copyright (c) 2019, 2021, Oracle and/or its affiliates. +# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. +# +# 1313 is the hugo default port +port=${1:-1313} + +hugo server -b http://localhost:$port/weblogic-toolkit-ui -D -p $port diff --git a/documentation/staging/1.2/runpublic.sh b/documentation/staging/1.2/runpublic.sh new file mode 100755 index 000000000..38a26b645 --- /dev/null +++ b/documentation/staging/1.2/runpublic.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +# Copyright (c) 2019, 2021, Oracle and/or its affiliates. +# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. + +# 1313 is the hugo default port +port=${1:-1313} + +hugo server -b http://$(hostname).$(dnsdomainname):$port/weblogic-toolkit-ui -D --bind=$(hostname).$(dnsdomainname) -p $port diff --git a/documentation/staging/1.2/static/css/theme-wktui.css b/documentation/staging/1.2/static/css/theme-wktui.css new file mode 100644 index 000000000..fa0468255 --- /dev/null +++ b/documentation/staging/1.2/static/css/theme-wktui.css @@ -0,0 +1,8 @@ +.wktui-two-images-column { + flex: 50%; + padding: 5px; +} + +.wktui-row { + display: flex; +} diff --git a/documentation/staging/1.2/static/images/auxiliary-image.png b/documentation/staging/1.2/static/images/auxiliary-image.png new file mode 100644 index 000000000..f5c898532 Binary files /dev/null and b/documentation/staging/1.2/static/images/auxiliary-image.png differ diff --git a/documentation/staging/1.2/static/images/logo.png b/documentation/staging/1.2/static/images/logo.png new file mode 100644 index 000000000..28828b74d Binary files /dev/null and b/documentation/staging/1.2/static/images/logo.png differ diff --git a/documentation/staging/1.2/static/images/primary-image.png b/documentation/staging/1.2/static/images/primary-image.png new file mode 100644 index 000000000..ca73cd8ae Binary files /dev/null and b/documentation/staging/1.2/static/images/primary-image.png differ diff --git a/documentation/staging/1.2/themes/learn/.editorconfig b/documentation/staging/1.2/themes/learn/.editorconfig new file mode 100644 index 000000000..12f0ef580 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/.editorconfig @@ -0,0 +1,16 @@ +# https://editorconfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +trim_trailing_whitespace = true + +[*.js] +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/documentation/staging/1.2/themes/learn/.gitignore b/documentation/staging/1.2/themes/learn/.gitignore new file mode 100644 index 000000000..64297518e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/.gitignore @@ -0,0 +1,3 @@ +.DS_Store +public/ +exampleSite/public diff --git a/documentation/staging/1.2/themes/learn/.grenrc.yml b/documentation/staging/1.2/themes/learn/.grenrc.yml new file mode 100644 index 000000000..ad31ac817 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/.grenrc.yml @@ -0,0 +1,25 @@ +--- + dataSource: "prs" + prefix: "v" + onlyMilestones: false + changelogFilename: "CHANGELOG.md" + includeMessages: "all" + ignoreIssuesWith: + - "support" + ignoreLabels: + - "duplicate" + - "invalid" + - "wontfix" + groupBy: + New features: + - "feature" + Bug Fixes: + - "bug" + Enhancements: + - "enhancement" + Internationalisation: + - "i18n" + Theme Meta: + - "meta" + Uncategorised: + - "closed" diff --git a/documentation/staging/1.2/themes/learn/CHANGELOG.md b/documentation/staging/1.2/themes/learn/CHANGELOG.md new file mode 100644 index 000000000..b5f5eac9f --- /dev/null +++ b/documentation/staging/1.2/themes/learn/CHANGELOG.md @@ -0,0 +1,226 @@ +# Changelog + +## v2.5.0 (01/06/2020) + +#### New features + +- [**feature**] Allow custom css files to be loaded by configuration [#376](https://github.com/matcornic/hugo-theme-learn/pull/376) +- [**feature**] Added flag to turn off image featherlight [#333](https://github.com/matcornic/hugo-theme-learn/pull/333) + +#### Bug Fixes + +- [**bug**] fix null pointer when no params on image url [#383](https://github.com/matcornic/hugo-theme-learn/pull/383) +- [**bug**] can't give argument to non-function not .Params.hidden [#403](https://github.com/matcornic/hugo-theme-learn/pull/403) +- [**bug**] Fix .File.UniqueID on zero object warning [#372](https://github.com/matcornic/hugo-theme-learn/pull/372) +- [**bug**] fix select option color in Chrome [#345](https://github.com/matcornic/hugo-theme-learn/pull/345) +- [**bug**] remove unneeded spaces from HTML [#320](https://github.com/matcornic/hugo-theme-learn/pull/320) +- [**bug**] Avoid displaying hidden sections in menu [#354](https://github.com/matcornic/hugo-theme-learn/pull/354) + +#### Enhancements + +- [**enhancement**] Updated theme installation documentation link. [#390](https://github.com/matcornic/hugo-theme-learn/pull/390) +- [**enhancement**] [ImgBot] Optimize images [#366](https://github.com/matcornic/hugo-theme-learn/pull/366) +- [**enhancement**] fix extra spaces in the description [#339](https://github.com/matcornic/hugo-theme-learn/pull/339) +- [**enhancement**] change to minified 'autocomplete.js' for improved performance [#321](https://github.com/matcornic/hugo-theme-learn/pull/321) + +#### Internationalisation + +- [**i18n**] Fix: typos [#343](https://github.com/matcornic/hugo-theme-learn/pull/343) +- [**i18n**] Fix: typo [#342](https://github.com/matcornic/hugo-theme-learn/pull/342) +- [**i18n**] Incorrect english in notice documentation [#336](https://github.com/matcornic/hugo-theme-learn/pull/336) +- [**i18n**] Add Chinese language for this theme [#349](https://github.com/matcornic/hugo-theme-learn/pull/349) +- [**i18n**] Add jp and zh cn [#335](https://github.com/matcornic/hugo-theme-learn/pull/335) +- [**i18n**] Added Russian translation [#332](https://github.com/matcornic/hugo-theme-learn/pull/332) + +#### Theme Meta + +- [**meta**] Fix various linting warnings [#405](https://github.com/matcornic/hugo-theme-learn/pull/405) +- [**meta**] Netlify build on 0.66.0 [#377](https://github.com/matcornic/hugo-theme-learn/pull/377) +- [**meta**] add inteliver documentation showcase [#331](https://github.com/matcornic/hugo-theme-learn/pull/331) + +--- + +## v2.4.0 (04/09/2019) + +#### Bug Fixes + +- [**bug**] correct GitHub capitalization [#293](https://github.com/matcornic/hugo-theme-learn/pull/293) +- [**bug**] fix 'locate' typo [#285](https://github.com/matcornic/hugo-theme-learn/pull/285) +- [**bug**] Remove reference to the unused horsey CSS [#284](https://github.com/matcornic/hugo-theme-learn/pull/284) +- [**bug**] Fix invalid HTML in 404 template. [#271](https://github.com/matcornic/hugo-theme-learn/pull/271) + +#### Enhancements + +- [**enhancement**] Delete html5shiv-printshiv.min.js [#319](https://github.com/matcornic/hugo-theme-learn/pull/319) +- [**enhancement**] remove html5shiv [#315](https://github.com/matcornic/hugo-theme-learn/pull/315) +- [**enhancement**] Fix deprecated .Hugo, .UniqueID and .URL references [#303](https://github.com/matcornic/hugo-theme-learn/pull/303) +- [**enhancement**] Fix type lines 364 and 369 [#304](https://github.com/matcornic/hugo-theme-learn/pull/304) +- [**enhancement**] remove unneeded type="text/css" [#298](https://github.com/matcornic/hugo-theme-learn/pull/298) +- [**enhancement**] remove unneeded type="text/css" [#297](https://github.com/matcornic/hugo-theme-learn/pull/297) +- [**enhancement**] HTTPS links in footer [#295](https://github.com/matcornic/hugo-theme-learn/pull/295) +- [**enhancement**] remove unneeded type="text/css" [#292](https://github.com/matcornic/hugo-theme-learn/pull/292) +- [**enhancement**] Make shortcodes & example site compatible with Hugo v0.55 [#281](https://github.com/matcornic/hugo-theme-learn/pull/281) + +#### Internationalisation + +- [**i18n**] Added German and Arabic translation [#312](https://github.com/matcornic/hugo-theme-learn/pull/312) + +#### Theme Meta + +- [**meta**] Added Tshark.dev as example site [#318](https://github.com/matcornic/hugo-theme-learn/pull/318) + +--- + +## v2.3.0 (16/04/2019) + +#### New features + +- [**feature**] Added support for tags [#196](https://github.com/matcornic/hugo-theme-learn/pull/196) + +#### Bug Fixes + +- [**bug**] Fix issue where "children" shortcode only shows top level. [#252](https://github.com/matcornic/hugo-theme-learn/pull/252) +- [**bug**] Fix translation when using a custom baseURL [#234](https://github.com/matcornic/hugo-theme-learn/pull/234) +- [**bug**] Preventing left/right arrow key navigation in textareas [#241](https://github.com/matcornic/hugo-theme-learn/pull/241) +- [**bug**] Update menu.html to include the check icon [#229](https://github.com/matcornic/hugo-theme-learn/pull/229) + +#### Enhancements + +- [**enhancement**] Render the ```mermaid blocks into graphs [#226](https://github.com/matcornic/hugo-theme-learn/pull/226) +- [**enhancement**] Remove oudated versions of jquery & modernizr libraries [#259](https://github.com/matcornic/hugo-theme-learn/pull/259) +- [**enhancement**] Various Updates [#237](https://github.com/matcornic/hugo-theme-learn/pull/237) +- [**enhancement**] Use style instead of width and height in logo [#250](https://github.com/matcornic/hugo-theme-learn/pull/250) +- [**enhancement**] [ImgBot] Optimize images [#222](https://github.com/matcornic/hugo-theme-learn/pull/222) +- [**enhancement**] remove duplicate icon and fix incorrect favicon type [#227](https://github.com/matcornic/hugo-theme-learn/pull/227) +- [**enhancement**] HTTPS links in exampleSite menu-footer [#223](https://github.com/matcornic/hugo-theme-learn/pull/223) + +#### Internationalisation + +- [**i18n**] Dutch i18n [#239](https://github.com/matcornic/hugo-theme-learn/pull/239) + +#### Theme Meta + +- [**meta**] Add .editorconfig [#224](https://github.com/matcornic/hugo-theme-learn/pull/224) + +--- + +## v2.2.0 (28/01/2019) + +#### New features + +- [**feature**] Sitewide param to enable or disable next/previous page buttons and breadcrumbs [#184](https://github.com/matcornic/hugo-theme-learn/pull/184) + +#### Bug Fixes + +- [**bug**] Fix baseurl used by search to load json data [#177](https://github.com/matcornic/hugo-theme-learn/pull/177) +- [**bug**] Updated CSS link to fontawesome library [#186](https://github.com/matcornic/hugo-theme-learn/pull/186) +- [**bug**] Close / Cancel search icon not showing in input box [#215](https://github.com/matcornic/hugo-theme-learn/pull/215) +- [**bug**] Prevent left and right keydown events while in input fields [#219](https://github.com/matcornic/hugo-theme-learn/pull/219) +- [**bug**] xss fix [#182](https://github.com/matcornic/hugo-theme-learn/pull/182) +- [**bug**] Fix error in blockquote documentation fixes #165 [#190](https://github.com/matcornic/hugo-theme-learn/pull/190) + +#### Enhancements + +- [**enhancement**] Update mermaid.js to a499296 [#199](https://github.com/matcornic/hugo-theme-learn/pull/199) +- [**enhancement**] Update Font Awesome to 5.0.6 [#129](https://github.com/matcornic/hugo-theme-learn/pull/129) +- [**enhancement**] Update 404.html alttext [#161](https://github.com/matcornic/hugo-theme-learn/pull/161) +- [**enhancement**] Remove CSS source map metadata [#167](https://github.com/matcornic/hugo-theme-learn/pull/167) +- [**enhancement**] Load github images in examplesite via https instead of http [#180](https://github.com/matcornic/hugo-theme-learn/pull/180) +- [**enhancement**] Load main site logo via BaseUrl [#185](https://github.com/matcornic/hugo-theme-learn/pull/185) +- [**enhancement**] HTTPS links in examplesite sidebar [#200](https://github.com/matcornic/hugo-theme-learn/pull/200) +- [**enhancement**] Use correct input type for search [#205](https://github.com/matcornic/hugo-theme-learn/pull/205) +- [**enhancement**] HTTPS link to learn.getgrav.org [#207](https://github.com/matcornic/hugo-theme-learn/pull/207) +- [**enhancement**] Update html5shiv-printshiv.min.js [#208](https://github.com/matcornic/hugo-theme-learn/pull/208) +- [**enhancement**] Remove whitespace from clippy.svg [#211](https://github.com/matcornic/hugo-theme-learn/pull/211) +- [**enhancement**] Upgrade fontawesome to 5.6.3 [#218](https://github.com/matcornic/hugo-theme-learn/pull/218) +- [**enhancement**] fix clickable nodes style in mermaid [#169](https://github.com/matcornic/hugo-theme-learn/pull/169) + +#### Internationalisation + +- [**i18n**] French language correction [#157](https://github.com/matcornic/hugo-theme-learn/pull/157) +- [**i18n**] French language correction [#158](https://github.com/matcornic/hugo-theme-learn/pull/158) +- [**i18n**] Add indonesian translation [#159](https://github.com/matcornic/hugo-theme-learn/pull/159) +- [**i18n**] Add Turkish i18n config file [#175](https://github.com/matcornic/hugo-theme-learn/pull/175) + +#### Theme Meta + +- [**meta**] Fix wercker builds [#178](https://github.com/matcornic/hugo-theme-learn/pull/178) +- [**meta**] Declare netlify buildsteps in repo file rather than in webui [#217](https://github.com/matcornic/hugo-theme-learn/pull/217) + +--- + +## v2.1.0 (10/08/2018) + +#### Internationalisation + +- [**i18n**] Clean up the English language phrasing [#146](https://github.com/matcornic/hugo-theme-learn/pull/146) +- [**i18n**] Updated _index.en.md for typo "names" [#150](https://github.com/matcornic/hugo-theme-learn/pull/150) + +#### Theme Meta + +- [**meta**] Add license scan report and status [#151](https://github.com/matcornic/hugo-theme-learn/pull/151) + +#### Uncategorised + +- [**closed**] Different viewport [#122](https://github.com/matcornic/hugo-theme-learn/pull/122) +- [**closed**] TranslationBaseName replaced for Name on archetypes template [#145](https://github.com/matcornic/hugo-theme-learn/pull/145) +- [**closed**] Improved variant of #119, as per request [#124](https://github.com/matcornic/hugo-theme-learn/pull/124) +- [**closed**] role="" is invalid [#121](https://github.com/matcornic/hugo-theme-learn/pull/121) +- [**closed**] Related to previous PR [#120](https://github.com/matcornic/hugo-theme-learn/pull/120) +- [**closed**] Issue #111 for _index.fr.md [#117](https://github.com/matcornic/hugo-theme-learn/pull/117) +- [**closed**] Issue #111 for _index.en.md [#116](https://github.com/matcornic/hugo-theme-learn/pull/116) +- [**closed**] Issue #111 for theme-green.css [#114](https://github.com/matcornic/hugo-theme-learn/pull/114) +- [**closed**] Issue #111 for theme-red.css [#113](https://github.com/matcornic/hugo-theme-learn/pull/113) +- [**closed**] Issue #111 for theme-blue.css [#112](https://github.com/matcornic/hugo-theme-learn/pull/112) +- [**closed**] Issue #111 for theme-mine.css [#115](https://github.com/matcornic/hugo-theme-learn/pull/115) +- [**closed**] fix #77 : no wrap images that already wrapped [#118](https://github.com/matcornic/hugo-theme-learn/pull/118) +- [**closed**] doc: Keep icons aligned [#110](https://github.com/matcornic/hugo-theme-learn/pull/110) +- [**closed**] Add Portuguese translation [#109](https://github.com/matcornic/hugo-theme-learn/pull/109) +- [**closed**] Use `relURL` where possible [#102](https://github.com/matcornic/hugo-theme-learn/pull/102) +- [**closed**] Bug fix in sidebar menu and children description generation [#105](https://github.com/matcornic/hugo-theme-learn/pull/105) +- [**closed**] fix some typo [#104](https://github.com/matcornic/hugo-theme-learn/pull/104) +- [**closed**] Added a `menuTitle` attribute to partials/menu.html [#90](https://github.com/matcornic/hugo-theme-learn/pull/90) +- [**closed**] allowing comments system [#86](https://github.com/matcornic/hugo-theme-learn/pull/86) +- [**closed**] Add spanish translation [#85](https://github.com/matcornic/hugo-theme-learn/pull/85) +- [**closed**] Replace horsey with Pixabay's autocomplete [#75](https://github.com/matcornic/hugo-theme-learn/pull/75) +- [**closed**] Added info about 'draft:true' [#74](https://github.com/matcornic/hugo-theme-learn/pull/74) +- [**closed**] Remove white space from `align` parameter [#63](https://github.com/matcornic/hugo-theme-learn/pull/63) + +--- + +## v2.0.0 (20/08/2017) + +#### Uncategorised + +- [**closed**] V2 [#56](https://github.com/matcornic/hugo-theme-learn/pull/56) + +--- + +## v1.1.0 (22/07/2017) + +#### Bug Fixes + +- [**bug**] Fix sticky header jumpiness [#45](https://github.com/matcornic/hugo-theme-learn/pull/45) + +#### Uncategorised + +- [**closed**] Fix anchor scrolling that hides behind top nav bar [#46](https://github.com/matcornic/hugo-theme-learn/pull/46) +- [**closed**] feat: Change the default code color [#43](https://github.com/matcornic/hugo-theme-learn/pull/43) +- [**closed**] Use index pages + automatic navigation arrows [#36](https://github.com/matcornic/hugo-theme-learn/pull/36) + +--- + +## v1.0.0 (25/03/2017) + +#### Uncategorised + +- [**closed**] Search [#18](https://github.com/matcornic/hugo-theme-learn/pull/18) +- [**closed**] Extracted menu footer content to separate partial file [#35](https://github.com/matcornic/hugo-theme-learn/pull/35) +- [**closed**] feat: style Hugo figure shortcode [#33](https://github.com/matcornic/hugo-theme-learn/pull/33) +- [**closed**] Fix URL for 'Edit this page' on Windows [#27](https://github.com/matcornic/hugo-theme-learn/pull/27) +- [**closed**] Revert "Menu generation using Content file instead directories" [#10](https://github.com/matcornic/hugo-theme-learn/pull/10) +- [**closed**] (#25) use .Site.BaseURL to lcoate static assets [#26](https://github.com/matcornic/hugo-theme-learn/pull/26) +- [**closed**] Menu ordering and definition in config.toml [#8](https://github.com/matcornic/hugo-theme-learn/pull/8) +- [**closed**] Menu generation using Content file instead directories [#5](https://github.com/matcornic/hugo-theme-learn/pull/5) +- [**closed**] Add Checkmark On visited Links [#4](https://github.com/matcornic/hugo-theme-learn/pull/4) +- [**closed**] doc: Add theme installation instructions [#1](https://github.com/matcornic/hugo-theme-learn/pull/1) diff --git a/documentation/staging/1.2/themes/learn/LICENSE.md b/documentation/staging/1.2/themes/learn/LICENSE.md new file mode 100644 index 000000000..0cf9fcb49 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/LICENSE.md @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2014 Grav +Copyright (c) 2016 MATHIEU CORNIC +Copyright (c) 2017 Valere JEANTET + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/documentation/staging/1.2/themes/learn/README.md b/documentation/staging/1.2/themes/learn/README.md new file mode 100644 index 000000000..3e0801e9c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/README.md @@ -0,0 +1,97 @@ +# Hugo Learn Theme + +This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/). + +Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme. + +[![wercker status](https://app.wercker.com/status/233466a2be73fcea400e7dc02ef6adf9/s/master "wercker status")](https://app.wercker.com/project/byKey/233466a2be73fcea400e7dc02ef6adf9) +[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield) + +## Main features + +- Automatic Search +- Multilingual mode +- Unlimited menu levels +- Automatic next/prev buttons to navigate through menu entries +- Image resizing, shadow… +- Attachments files +- List child pages +- Mermaid diagram (flowchart, sequence, gantt) +- Customizable look and feel and themes variants +- Buttons, Tip/Note/Info/Warning boxes, Expand + +## Installation + +Navigate to your themes folder in your Hugo site and use the following commands: + +```shell +cd themes/ +git clone https://github.com/matcornic/hugo-theme-learn.git +``` + +Check that your Hugo version is minimum `0.25` with `hugo version`. + +![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png) + +## Usage + +- [Visit the documentation](https://learn.netlify.com/en/) + +## Download old versions (prior to 2.0.0) + +If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0` + +- Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip +- Git way: + +```shell +cd themes/hugo-theme-learn +git checkout tags/1.1.0 +``` + +For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip + +## Credits + +Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work ! + +## License + +[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large) + +## Releasing + +Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes) + +- Check all MRs assigned to the milestone are closed or pushed back to another release +- Close the milestone +- Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.) +- Tag and push the repo + + ```shell + git tag + git push origin + ``` + +- Generate CHANGELOG.md with _gren_ + + ```shell + gren changelog --override --generate --tags=all + ``` + +- Fix the date for the current release in CHANGELOG.md +- Add the changelog to git and update the tag + + ```shell + git add CHANGELOG.md + git commit -m "Ship tag " + git push origin master + git tag -f + git push --force origin + ``` + +- Generate release with _gren_ + + ```shell + gren release -t + ``` diff --git a/documentation/staging/1.2/themes/learn/archetypes/chapter.md b/documentation/staging/1.2/themes/learn/archetypes/chapter.md new file mode 100644 index 000000000..a29ba1bd4 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/archetypes/chapter.md @@ -0,0 +1,13 @@ ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/archetypes/default.md b/documentation/staging/1.2/themes/learn/archetypes/default.md new file mode 100644 index 000000000..5124e2a77 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/archetypes/default.md @@ -0,0 +1,7 @@ ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 ++++ + +Lorem Ipsum. \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/LICENSE.md b/documentation/staging/1.2/themes/learn/exampleSite/LICENSE.md new file mode 100644 index 000000000..973626de8 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/LICENSE.md @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2016 MATHIEU CORNIC + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/config.toml b/documentation/staging/1.2/themes/learn/exampleSite/config.toml new file mode 100644 index 000000000..c1381da47 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/config.toml @@ -0,0 +1,112 @@ +baseURL = "/" +languageCode = "en-US" +defaultContentLanguage = "en" + +title = "Hugo Learn Documentation" +theme = "hugo-theme-learn" +themesdir = "../.." +metaDataFormat = "yaml" +defaultContentLanguageInSubdir= true + +[params] + editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/" + description = "Documentation for Hugo Learn Theme" + author = "Mathieu Cornic" + showVisitedLinks = true + disableBreadcrumb = false + disableNextPrev = false + disableLandingPageButton = true + disableMermaid = false + customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" + titleSeparator = "::" + +[outputs] +home = [ "HTML", "RSS", "JSON"] + +[Languages] +[Languages.en] +title = "Documentation for Hugo Learn Theme" +weight = 1 +languageName = "English" +landingPageURL = "/en" +landingPageName = " Home" + +[[Languages.en.menu.shortcuts]] +name = " GitHub repo" +identifier = "ds" +url = "https://github.com/matcornic/hugo-theme-learn" +weight = 10 + +[[Languages.en.menu.shortcuts]] +name = " Showcases" +url = "showcase" +weight = 11 + +[[Languages.en.menu.shortcuts]] +name = " Hugo Documentation" +identifier = "hugodoc" +url = "https://gohugo.io/" +weight = 20 + +[[Languages.en.menu.shortcuts]] +name = " Credits" +url = "/credits" +weight = 30 + +[Languages.fr] +title = "Documentation du thème Hugo Learn" +weight = 2 +languageName = "Français" +landingPageURL = "/fr" +landingPageName = " Accueil" + +[[Languages.fr.menu.shortcuts]] +name = " Repo GitHub" +identifier = "ds" +url = "https://github.com/matcornic/hugo-theme-learn" +weight = 10 + +[[Languages.fr.menu.shortcuts]] +name = " Vitrine" +url = "/showcase" +weight = 11 + +[[Languages.fr.menu.shortcuts]] +name = " Documentation Hugo" +identifier = "hugodoc" +url = "https://gohugo.io/" +weight = 20 + +[[Languages.fr.menu.shortcuts]] +name = " Crédits" +url = "/credits" +weight = 30 + +[Languages.zh] +title = "Hugo 主题的 Learn 文档" +weight = 3 +languageName = "简体中文" +landingPageURL = "/zh" +landingPageName = " 家" + +[[Languages.zh.menu.shortcuts]] +name = " GitHub 仓库" +identifier = "ds" +url = "https://github.com/matcornic/hugo-theme-learn" +weight = 10 + +[[Languages.zh.menu.shortcuts]] +name = " 展示区" +url = "/showcase" +weight = 11 + +[[Languages.zh.menu.shortcuts]] +name = " Hugo 文档" +identifier = "hugodoc" +url = "https://gohugo.io/" +weight = 20 + +[[Languages.zh.menu.shortcuts]] +name = " 鸣谢" +url = "/credits" +weight = 30 diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/_index.en.md new file mode 100644 index 000000000..a36357957 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/_index.en.md @@ -0,0 +1,41 @@ +--- +title: "Learn Theme for Hugo" +--- + +# Hugo learn theme + +[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**. + +This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP. + +{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}}) +{{% /notice %}} + +## Main features + +* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}}) +* [Multilingual mode]({{%relref "cont/i18n/_index.md" %}}) +* **Unlimited menu levels** +* **Automatic next/prev buttons to navigate through menu entries** +* [Image resizing, shadow...]({{%relref "cont/markdown.en.md#images" %}}) +* [Attachments files]({{%relref "shortcodes/attachments.en.md" %}}) +* [List child pages]({{%relref "shortcodes/children/_index.md" %}}) +* [Mermaid diagram]({{%relref "shortcodes/mermaid.en.md" %}}) (flowchart, sequence, gantt) +* [Customizable look and feel and themes variants]({{%relref "basics/style-customization/_index.md"%}}) +* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}}) + +![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow) + +## Contribute to this documentation +Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it + +{{% notice info %}} +Your modification will be deployed automatically when merged. +{{% /notice %}} + +## Documentation website +This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn) + +{{% notice note %}} +Automatically published and hosted thanks to [Netlify](https://www.netlify.com/). Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/) +{{% /notice %}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/_index.fr.md new file mode 100644 index 000000000..40b2dc352 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/_index.fr.md @@ -0,0 +1,43 @@ +--- +title: "Learn Theme for Hugo" +--- + +# Thème Hugo learn + +[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) est un thème pour [Hugo](https://gohugo.io/), un générateur de site statique, rapide et modern, écrit en Go. Tandis que Hugo est souvent utilisé pour des blogs, ce thème multi-langue est **entièrement conçu pour la documentation**. + +Ce thème est un portage partiel du [thème Learn](http://learn.getgrav.org/) de [Grav](https://getgrav.org/), un CMS modern écrit en PHP. + +{{% notice tip %}}Le thème Learn fonctionne grâce à la structure de page aborescentes pour organiser le contenu: tous les contenus sont des pages qui appartiennent à d'autres pages. [Plus d'infos]({{%relref "cont/pages/_index.md"%}}) +{{% /notice %}} + +## Fonctionnalités principales + +* [Recherche automatique]({{%relref "basics/configuration/_index.md#activer-recherche" %}}) +* [Mode multi-langue]({{%relref "cont/i18n/_index.md" %}}) +* **Nombre de niveau infini dans le menu** +* **Boutons suivant/précédent automatiquement générés pour naviguer entre les items du menu** +* [Taille d'image, ombres...]({{%relref "cont/markdown.fr.md#images" %}}) +* [Fichiers joints]({{%relref "shortcodes/attachments.fr.md" %}}) +* [Lister les pages filles]({{%relref "shortcodes/children/_index.md" %}}) +* [Diagrammes Mermaid]({{%relref "shortcodes/mermaid.fr.md" %}}) (flowchart, sequence, gantt) +* [Style configurable and variantes de couleurs]({{%relref "basics/style-customization/_index.md"%}}) +* [Boutons]({{%relref "shortcodes/button.fr.md" %}}), [Messages Astuce/Note/Info/Attention]({{%relref "shortcodes/notice.fr.md" %}}), [Expand]({{%relref "shortcodes/expand.fr.md" %}}) + +![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow) + +## Contribuer à cette documentation + +N'hésitez pas à mettre à jour ce contenu en cliquant sur le lien **Modifier cette page** en haut de chaque page, et créer la Pull Request associée. + +{{% notice info %}} +Votre modification sera déployée automatiquement quand elle sera mergée. +{{% /notice %}} + +## Site de documentation + +Cette documentation statique a été générée avec Hugo avec une simple commande : `hugo -t hugo-theme-learn` -- le code source est [disponible sur Github](https://github.com/matcornic/hugo-theme-learn) + +{{% notice note %}} +Le site est auomatiquement publié et hébergé par [Netlify](https://www.netlify.com/). Plus d'infos sur le [déploiement de site Hugo avec Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)(En anglais) +{{% /notice %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.en.md new file mode 100644 index 000000000..56e2968e2 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.en.md @@ -0,0 +1,12 @@ +--- +title: Basics +weight: 5 +pre: "1. " +chapter: true +--- + +### Chapter 1 + +# Basics + +Discover what this Hugo theme is all about and the core-concepts behind it. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.fr.md new file mode 100644 index 000000000..1b800c905 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.fr.md @@ -0,0 +1,12 @@ +--- +title: Démarrage +weight: 5 +pre: "1. " +chapter: true +--- + +### Chapitre 1 + +# Démarrage + +Découvrez comment utiliser ce thème Hugo et apprenez-en les concepts diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.zh.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.zh.md new file mode 100644 index 000000000..6c5d5dacc --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/_index.zh.md @@ -0,0 +1,12 @@ +--- +title: 基础 +weight: 5 +pre: "1. " +chapter: true +--- + +### 章节 1 + +# 基础 + +了解该 Hugo 主题的特点以及背后的核心概念。 diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.en.md new file mode 100644 index 000000000..c46212524 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.en.md @@ -0,0 +1,112 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Configuration +weight: 20 +--- + +## Global site parameters + +On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default). + +Note that some of these parameters are explained in details in other sections of this documentation. + +```toml +[params] + # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. + # Useful to give opportunity to people to create merge request for your doc. + # See the config.toml file from this documentation site to have an example. + editURL = "" + # Author of the site, will be used in meta information + author = "" + # Description of the site, will be used in meta information + description = "" + # Shows a checkmark for visited pages on the menu + showVisitedLinks = false + # Disable search function. It will hide search bar + disableSearch = false + # Javascript and CSS cache are automatically busted when new version of site is generated. + # Set this to true to disable this behavior (some proxies don't handle well this optimization) + disableAssetsBusting = false + # Set this to true to disable copy-to-clipboard button for inline code. + disableInlineCopyToClipBoard = false + # A title for shortcuts in menu is set by default. Set this to true to disable it. + disableShortcutsTitle = false + # If set to false, a Home button will appear below the search bar on the menu. + # It is redirecting to the landing page of the current language if specified. (Default is "/") + disableLandingPageButton = true + # When using mulitlingual website, disable the switch language button. + disableLanguageSwitchingButton = false + # Hide breadcrumbs in the header and only show the current page title + disableBreadcrumb = true + # If set to true, prevents Hugo from including the mermaid module if not needed (will reduce load times and traffic) + disableMermaid = false + # Specifies the remote location of the mermaid js + customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" + # Hide Next and Previous page buttons normally displayed full height beside content + disableNextPrev = true + # Order sections in menu by "weight" or "title". Default to "weight" + ordersectionsby = "weight" + # Change default color scheme with a variant one. Can be "red", "blue", "green". + themeVariant = "" + # Provide a list of custom css files to load relative from the `static/` folder in the site root. + custom_css = ["css/foo.css", "css/bar.css"] + # Change the title separator. Default to "::". + titleSeparator = "-" +``` + +## Activate search + +If not already present, add the follow lines in the same `config.toml` file. + +```toml +[outputs] +home = [ "HTML", "RSS", "JSON"] +``` + +Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine. + +> Hugo generate lunrjs index.json at the root of public folder. +> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem + +## Mermaid + +The mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. + +> Example: +> +> Mermaid is globally disabled. By default it won't be loaded by any page. +> On page "Architecture" you need a class diagram. You can set the mermaid parameters locally to only load mermaid on this page (not on the others). + +You also can disable mermaid for specific pages while globally enabled. + +## Home Button Configuration + +If the `disableLandingPage` option is set to `false`, an Home button will appear +on the left menu. It is an alternative for clicking on the logo. To edit the +appearance, you will have to configure two parameters for the defined languages: + +```toml +[Lanugages] +[Lanugages.en] +... +landingPageURL = "/en" +landingPageName = " Redirect to Home" +... +[Lanugages.fr] +... +landingPageURL = "/fr" +landingPageName = " Accueil" +... +``` + +If those params are not configured for a specific language, they will get their +default values: + +```toml +landingPageURL = "/" +landingPageName = " Home" +``` + +The home button is going to looks like this: + +![Default Home Button](/en/basics/configuration/images/home_button_defaults.jpg?width=100%) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.fr.md new file mode 100644 index 000000000..7f618e48f --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/_index.fr.md @@ -0,0 +1,107 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Configuration +weight: 20 +--- + +## Paramètres globaux du site + +En plus de la [configuration globale d'Hugo](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** vous permet de définir les paramètres suivant dans votre fichier `config.toml` (ci-dessous sont affichées les valeurs par défaut). + +Notez que certains de ces paramètres sont expliqués en détails dans d'autres sections de cette documentation. + +```toml +[params] + # L'URL préfixe pour éditer la page courante. Ce paramètre affichera un bouton "Modifier cette page" on haut de de chacune des pages. + # Pratique pour donner les possibilité à vos utilisateurs de créer une merge request pour votre doc. + # Allez voir le fichier config.toml de cette documentation pour avoir un exemple. + editURL = "" + # Autheur du site, est utilisé dans les informations meta + author = "" + # Description du site, est utilisé dans les informations meta + description = "" + # Affiche une icône lorsque la page a été visitée + showVisitedLinks = false + # Désactive la fonction de recherche. Une valeur à true cache la barre de recherche. + disableSearch = false + # Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée. + # Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys) + disableAssetsBusting = false + # Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne. + disableInlineCopyToClipBoard = false + # Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher. + disableShortcutsTitle = false + # S'il est réglé sur faux, un bouton Accueil apparaîtra sous la barre de recherche dans le menu. + # Il redirige vers la page d'accueil de la langue actuelle si cela est spécifié. (La valeur par défaut est "/") + disableLandingPageButton = true + # Si défini à true, empêche Hugo d'inclure le module "mermaid" s'il n'est pas nécessaire (réduira les temps de chargement et le trafic) + disableMermaid = false + # Spécifie l'emplacement distant du mermaid js + customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" + # Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue. + disableLanguageSwitchingButton = false + # Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight" + ordersectionsby = "weight" + # Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green". + themeVariant = "" + # Fournissez une liste de fichiers css personnalisés à charger par rapport depuis le dossier `static/` à la racine du site. + custom_css = ["css/foo.css", "css/bar.css"] +``` + +## Activer la recherche {#activer-recherche} + +Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `config.toml`. + +```toml +[outputs] +home = [ "HTML", "RSS", "JSON"] +``` + +Le thème *Learn* utilise les dernières améliorations d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js. + +> Hugo génère lunrjs index.json à la racine du dossier `public`. +> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque. + +## Mermaid + +Les paramètres de configuration du mermaid peuvent également être définis sur une page spécifique. Dans ce cas, le paramètre global sera écrasé par le paramètre local. + +> Exemple: +> +> Mermaid est globalement handicapé. Par défaut, elle ne sera chargée par aucune page. +> À la page "Architecture", vous avez besoin d'un diagramme de classe. Vous pouvez régler les paramètres de mermaid localement pour ne charger que la sirène sur cette page (pas sur les autres). + +Vous pouvez également désactiver mermaid pour des pages spécifiques tout en l'activant globalement. + +## Configuration du bouton Accueil + +Si l'option `disableLandingPage` est définie sur `false`, un bouton +"Accueil" apparaîtra dans le menu de gauche. C'est une alternative pour cliquer +sur le logo. Pour modifier le vous devrez configurer deux paramètres pour les +langues définies : + +```toml +[Lanugages] +[Lanugages.en] +... +landingPageURL = "/en" +landingPageName = " Redirect to Home" +... +[Lanugages.fr] +... +landingPageURL = "/fr" +landingPageName = " Accueil" +... +``` + +Si ces paramètres ne sont pas configurés pour une langue spécifique, ils +obtiendront leur valeurs par défaut: + +```toml +landingPageURL = "/" +landingPageName = " Home" +``` + +Le bouton d'accueil va ressembler à ceci: + +![Default Home Button](/en/basics/configuration/images/home_button_defaults.jpg?width=100%) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/images/home_button_defaults.jpg b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/images/home_button_defaults.jpg new file mode 100644 index 000000000..84b045d00 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/configuration/images/home_button_defaults.jpg differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.en.md new file mode 100644 index 000000000..e53d006c7 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.en.md @@ -0,0 +1,102 @@ +--- +title: Installation +weight: 15 +--- + +The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/). + +## Create your project + +Hugo provides a `new` command to create a new website. + +``` +hugo new site +``` + +## Install the theme + +Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) + +This theme's repository is: https://github.com/matcornic/hugo-theme-learn.git + +Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the `themes` directory + +## Basic configuration + +When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality. + +```toml +# Change the default theme to be use when building the site with Hugo +theme = "hugo-theme-learn" + +# For search functionality +[outputs] +home = [ "HTML", "RSS", "JSON"] +``` + +## Create your first chapter page + +Chapters are pages that contain other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section. + +``` +### Chapter 1 + +# Basics + +Discover what this Hugo theme is all about and the core concepts behind it. +``` + +renders as + +![A Chapter](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc) + +**Hugo-theme-learn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command + +``` +hugo new --kind chapter basics/_index.md +``` + +By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_. + +By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata. + +## Create your first content pages + +Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter: + +``` +hugo new basics/first-content.md +hugo new basics/second-content/_index.md +``` + +Feel free to edit thoses files by adding some sample content and replacing the `title` value in the beginning of the files. + +## Launching the website locally + +Launch by using the following command: + +``` +hugo serve +``` + +Go to `http://localhost:1313` + +You should notice three things: + +1. You have a left-side **Basics** menu, containing two submenus with names equal to the `title` properties in the previously created files. +2. The home page explains how to customize it by following the instructions. +3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat! + +## Build the website + +When your site is ready to deploy, run the following command: + +``` +hugo +``` + +A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server. + +{{% notice note %}} +This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/) +{{% /notice %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.fr.md new file mode 100644 index 000000000..268d0c3ce --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/_index.fr.md @@ -0,0 +1,100 @@ +--- +title: Installation +weight: 15 +--- + +Les étapes suivantes sont là pour vous aider à initialiser votre site. Si vous ne connaissez pas du tout Hugo, il est fortement conseillé de vous entrainer en suivant ce [super tuto pour débutants](https://gohugo.io/overview/quickstart/). + +## Créer votre projet + +Hugo fournit une commande `new` pour créer un nouveau site. + +``` +hugo new site +``` + +## Installer le thème + +Installer le thème **Hugo-theme-learn** en suivant [cette documentation](https://gohugo.io/themes/installing/) + +Le repo du thème est : https://github.com/matcornic/hugo-theme-learn.git + +Sinon, vous pouvez [télécharger le thème sous forme d'un fichier .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) et extrayez le dans votre dossier de thèmes. + +## Configuration simple + +Lorsque vous générez votre site, vous pouvez définir un thème en utilisant l'option `--theme`. Il est conseillé de modifier votre fichier de configuration `config.toml` and définir votre thème par défaut. En passant, ajoutez les prérequis à l'utilisation de la fonctionnalité de recherche. + +```toml +# Modifiez le thème pour qu'il soit utilisé par défaut à chaque génération de site. +theme = "hugo-theme-learn" + +# Pour la fonctionnalité de recherche +[outputs] +home = [ "HTML", "RSS", "JSON"] +``` + +## Créer votre première page chapitre + +Les *chapitres* sont des pages contenant d'autre pages filles. Elles ont un affichage spécial et contiennent habituellement juste un _nom_ de chapitre, le _titre_ et un _résumé_ de la section. + +``` +### Chapitre 1 + +# Démarrage + +Découvrez comment utiliser ce thème Hugo et apprenez en les concepts +``` + +s'affiche comme + +![Un chapitre](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc) + +**Hugo-theme-learn** fournit des archétypes pour créer des squelettes pour votre site. Commencez par créer votre premier chapitre avec la commande suivante: + +``` +hugo new --kind chapter basics/_index.md +``` + +En ouvrant le fichier généré, vous devriez voir la propriété `chapter=true` en haut, paramètre quit définit que le page est un _chapitre_. + +## Créer votre première page + +Puis, créez votre premier page dans le chapitre précédent. Pour ce faire, il existe deux possibilités : + +``` +hugo new basics/first-content.md +hugo new basics/second-content/_index.md +``` + +N'hésitez pas à éditer ces fichiers en ajoutant des exemple de contenu et en remplaçant le paramètre `title` au début du fichier. + +## Lancer le site localement + +Lancez la commande suivante : + +``` +hugo serve +``` + +Se rendre sur `http://localhost:1313` + +Vous devriez voir trois choses: + +1. Vous avez un menu **Basics** à gauche, qui contient deux sous-menu avec des noms égal au paramètre `title` des fichiers précédemment générés. +2. La page d'accueil vous explique comment la modifier. Suivez les instructions. +3. Avec la commande `hugo serve`, la page se rafraichit automatiquement à chaque fois que vous sauvegardez. Super ! + +## Générez le site + +Quand votre site est prêt à être déployé, lancez la commande suivante: + +``` +hugo +``` + +Un dossier `public` a été généré. Il contient tout le contenu statique et les ressources nécessaires pour votre site. Votre site peut maintenant être déployé en utilisant n'importe quel serveur ! + +{{% notice note %}} +Ce site peut être automatiquement publié et hébergé avec [Netlify](https://www.netlify.com/) ([Plus d'infos](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Sinon, vous pouvez utiliser les [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/) +{{% /notice %}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/images/chapter.png b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/images/chapter.png new file mode 100644 index 000000000..80da0c6d6 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/installation/images/chapter.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.en.md new file mode 100644 index 000000000..2b3f51d93 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.en.md @@ -0,0 +1,11 @@ +--- +title: Requirements +weight: 10 +disableToc: true +--- + +Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements. + +Just download latest version of [Hugo binary (> 0.25)](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac) : it's that simple. + +![Magic](/en/basics/requirements/images/magic.gif?classes=shadow) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.fr.md new file mode 100644 index 000000000..ae70caea5 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/_index.fr.md @@ -0,0 +1,11 @@ +--- +title: Prérequis +weight: 10 +disableToc: true +--- + +Grâce à la simplicité d'Hugo, cette page est vide car il n'y a quasi pas de prérequis pour utiliser le thème. + +Téléchargez la dernière version du [binaire Hugo (> 0.25)](https://gohugo.io/getting-started/installing/) pour votre Système d'exploitation (Windows, Linux, Mac) : et c'est tout ! + +![Magic](/en/basics/requirements/images/magic.gif?classes=shadow) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/images/magic.gif b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/images/magic.gif new file mode 100644 index 000000000..235c4edb3 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/requirements/images/magic.gif differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.en.md new file mode 100644 index 000000000..c6920c5d4 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.en.md @@ -0,0 +1,194 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Style customization +weight: 25 +--- + +**Hugo-theme-learn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/) + +In `themes/hugo-theme-learn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority. + +This theme defines the following partials : + +- *header*: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_ +- *custom-header*: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file +- *footer*: the footer of the content page (contains the arrows). _Not meant to be overwritten_ +- *custom-footer*: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file +- *favicon*: the favicon +- *logo*: the logo, on top left hand corner. +- *meta*: HTML meta tags, if you want to change default behavior +- *menu*: left menu. _Not meant to be overwritten_ +- *menu-footer*: footer of the the left menu +- *search*: search box +- *toc*: table of contents + +## Change the logo + +Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want. +You could use an `img` HTML tag and reference an image created under the *static* folder, or you could paste a SVG definition ! + +{{% notice note %}} +The size of the logo will adapt automatically +{{% /notice %}} + +## Change the favicon + +If your favicon is a png, just drop off your image in your local `static/images/` folder and name it `favicon.png` + +If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this: + +```html + +``` + +## Change default colors {#theme-variant} + +**Hugo Learn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself ! Default color scheme is based on [Grav Learn Theme](https://learn.getgrav.org/). + +### Red variant + +```toml +[params] + # Change default color scheme with a variant one. Can be "red", "blue", "green". + themeVariant = "red" +``` + +![Red variant](/en/basics/style-customization/images/red-variant.png?width=60pc) + +### Blue variant + +```toml +[params] + # Change default color scheme with a variant one. Can be "red", "blue", "green". + themeVariant = "blue" +``` + +![Blue variant](/en/basics/style-customization/images/blue-variant.png?width=60pc) + +### Green variant + +```toml +[params] + # Change default color scheme with a variant one. Can be "red", "blue", "green". + themeVariant = "green" +``` + +![Green variant](/en/basics/style-customization/images/green-variant.png?width=60pc) + +### 'Yours‘ variant + +First, create a new CSS file in your local `static/css` folder prefixed by `theme` (e.g. with _mine_ theme `static/css/theme-mine.css`). Copy the following content and modify colors in CSS variables. + +```css + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#1C90F3; /* Color of links */ + --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */ + --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ + + --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #20272b; /* Color of
separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} +``` + +Then, set the `themeVariant` value with the name of your custom theme file. That's it ! + +```toml +[params] + # Change default color scheme with a variant one. Can be "red", "blue", "green". + themeVariant = "mine" +``` diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.fr.md new file mode 100644 index 000000000..6daab9e84 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/_index.fr.md @@ -0,0 +1,194 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Personnalisation du style +weight: 25 +--- + +**Hugo-theme-learn** a été conçu pour être aussi configurable que possible en définissant plusieurs [partials](https://gohugo.io/templates/partials/) + +Dans `themes/hugo-theme-learn/layouts/partials/`, vous pourrez trouver tous les *partials* définis pour ce thème. Si vous avez besoin d'écraser quelque chose, ne modifiez pas le code directement. A la place, [suivez cette page](https://gohugo.io/themes/customizing/). Vous créerez alors un nouveau *partial* dans le dossier `layouts/partials` de votre site local. Ce *partial* aura la priorité. + +Ce thème définit les *partials* suivant : + +- *header*: l'en-tête de la page page (contient le fil d'Ariane). _Pas voué à être écrasé_ +- *custom-header*: En-tête personnalisé. Voué à être écrasé quand vous ajoutez des imports CSS. N'oubliez pas d'inclure la balise HTML `style` dans votre fichier +- *footer*: le pied-de-page de la page (contains les flèches). _Pas voué à être écrasé_ +- *custom-footer*: Pied-de-page personnalisé. Voué à être écrasé quand vous ajoutez du Javascript. N'oubliez pas d'inclure la balise HTML `javascript` dans votre fichier +- *favicon*: le favicon +- *logo*: le logo, affiché un haut à gauche. +- *meta*: les balises HTML meta, que vous pouvez écraser sans problème. +- *menu*: Le menu à gauche. _Pas voué à être écrasé_ +- *menu-footer*: Le pied-de-page du menu +- *search*: le champ de recherche +- *toc*: le sommaire + +## Changer le logo + +Créez un nouveau fichier dans `layouts/partials/`, nommé `logo.html`. Puis, écrivez le code HTML voulu. +Vous pourriez utiliser une balise HTML `img` et référencer une image créée dans le dossier *static*, voire même y coller un code SVG ! + +{{% notice note %}} +La taille du logo va s'adapter automatiquement +{{% /notice %}} + +## Changer le favicon + +Si votre favicon est un png, déposez votre image dans votre dossier local `static/images/` et nommez le `favicon.png` + +Si vous avez besoin de changer ce comportement par défaut, créer un nouveau fichier dans `layouts/partials/` et nommez le `favicon.html`. Puis ajoutez quelque chose comme: + +```html + +``` + +## Changer les couleurs par défaut {#theme-variant} + +**Hugo Learn theme** vous permet de choisir nativement entre 3 schéma de couleurs, mais n'hésitez pas à en ajouter d'autres ! Les couleurs par défaut sont celles de [Grav Learn Theme](https://learn.getgrav.org/). + +### Variante rouge + +```toml +[params] + # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". + themeVariant = "red" +``` + +![Variante rouge](/en/basics/style-customization/images/red-variant.png?width=60pc) + +### Variante bleue + +```toml +[params] + # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". + themeVariant = "blue" +``` + +![Variante bleue](/en/basics/style-customization/images/blue-variant.png?width=60pc) + +### Variante verte + +```toml +[params] + # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". + themeVariant = "green" +``` + +![Variante verte](/en/basics/style-customization/images/green-variant.png?width=60pc) + +### Votre variante + +Premièrement, créez un nouveau fichier CSS dans votre dossier `static/css`, préfixé par `theme` (ex: avec le theme_lemien_ `static/css/theme-lemien.css`). Copiez le contenu suivant et modifiez les couleurs dans les variables CSS. + +```css + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#1C90F3; /* Color of links */ + --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */ + --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ + + --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #20272b; /* Color of
separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} +``` + +Puis, configurez le paramètre `themeVariant` avec le nom de votre variante. C'est tout ! + +```toml +[params] + # Modifier le schéma de couleur par défaut. Peut être "red", "blue", "green". + themeVariant = "lemien" +``` diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/blue-variant.png b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/blue-variant.png new file mode 100644 index 000000000..4f79d58b1 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/blue-variant.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/green-variant.png b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/green-variant.png new file mode 100644 index 000000000..a4b73b58e Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/green-variant.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/red-variant.png b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/red-variant.png new file mode 100644 index 000000000..6af77497d Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/basics/style-customization/images/red-variant.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.en.md new file mode 100644 index 000000000..cbdc696a1 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.en.md @@ -0,0 +1,12 @@ +--- +title: Content +weight: 10 +chapter: true +pre: "2. " +--- + +### Chapter 2 + +# Content + +Find out how to create and organize your content quickly and intuitively. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.fr.md new file mode 100644 index 000000000..dae5873c8 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/_index.fr.md @@ -0,0 +1,12 @@ +--- +title: Contenu +weight: 10 +chapter: true +pre: "2. " +--- + +### Chapitre 2 + +# Contenu + +Découvrez comment créer et organiser votre contenu facilement et intuitivement. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.en.md new file mode 100644 index 000000000..d5fd99702 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.en.md @@ -0,0 +1,57 @@ +--- +title: Archetypes +weight: 10 +--- + +Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: [archetypes](https://gohugo.io/content/archetypes/). + +It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences. + +## Chapter {#archetypes-chapter} + +To create a Chapter page, run the following commands + +``` +hugo new --kind chapter /_index.md +``` + +It will create a page with predefined Front-Matter: + +```markdown ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. +``` + +## Default + +To create a default page, run either one of the following commands + +``` +# Either +hugo new //_index.md +# Or +hugo new /.md +``` + +It will create a page with predefined Front-Matter: + +```markdown ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 ++++ + +Lorem Ipsum. +``` diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.fr.md new file mode 100644 index 000000000..883c41865 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/archetypes.fr.md @@ -0,0 +1,57 @@ +--- +title: Archétypes +weight: 10 +--- + +En utilisant la commande: `hugo new [chemin vers nouveau contenu]`, vous pouvez créer un nouveau fichier avec la date et le title automatiquement initialisé. Même si c'est une fonctionnalité intéressante, elle reste limitée pour les auteurs actifs qui ont besoin de mieux : les [archetypes](https://gohugo.io/content/archetypes/). + +Les archétypes sont des squelettes de pages préconfigurées avec un Front Matter par défaut. Merci de vous référer à la documentation pour connaitre les différents types de page. + +## Chapitre {#archetypes-chapter} + +Pour créer un chapitre, lancez les commandes suivantes + +``` +hugo new --kind chapter /_index.md +``` + +Cela crééra une page avec le Front Matter suivant: + +```markdown ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. +``` + +## Défaut + +Pour créer une page classique, lancer l'une des deux commandes suivantes + +``` +# Soit +hugo new //_index.md +# Ou +hugo new /.md +``` + +Cela crééra une page avec le Front Matter suivant: + +```markdown ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +weight = 5 ++++ + +Lorem Ipsum. +``` \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.en.md new file mode 100644 index 000000000..c35327582 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.en.md @@ -0,0 +1,78 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Multilingual and i18n +weight: 30 +--- + +**Learn theme** is fully compatible with Hugo multilingual mode. + +It provides: + +- Translation strings for default values (English and French). Feel free to contribute ! +- Automatic menu generation from multilingual content +- In-browser language switching + +![I18n menu](/en/cont/i18n/images/i18n-menu.gif) + +## Basic configuration + +After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `config.toml` file. + +For example with current French and English website. + +```toml +# English is the default language +defaultContentLanguage = "en" +# Force to have /en/my-page and /fr/my-page routes, even for default language. +defaultContentLanguageInSubdir= true + +[Languages] +[Languages.en] +title = "Documentation for Hugo Learn Theme" +weight = 1 +languageName = "English" + +[Languages.fr] +title = "Documentation du thème Hugo Learn" +weight = 2 +languageName = "Français" +``` + +Then, for each new page, append the *id* of the language to the file. + +- Single file `my-page.md` is split in two files: + - in English: `my-page.en.md` + - in French: `my-page.fr.md` +- Single file `_index.md` is split in two files: + - in English: `_index.en.md` + - in French: `_index.fr.md` + +{{% notice info %}} +Be aware that only translated pages are displayed in menu. It's not replaced with default language content. +{{% /notice %}} + +{{% notice tip %}} +Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) Front Matter parameter to translate urls too. +{{% /notice %}} + +## Overwrite translation strings + +Translations strings are used for common default values used in the theme (*Edit this page* button, *Search placeholder* and so on). Translations are available in french and english but you may use another language or want to override default values. + +To override these values, create a new file in your local i18n folder `i18n/.toml` and inspire yourself from the theme `themes/hugo-theme-learn/i18n/en.toml` + +By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/matcornic/hugo-theme-learn/pulls) to the theme ! + +## Disable language switching + +Switching the language in the browser is a great feature, but for some reasons you may want to disable it. + +Just set `disableLanguageSwitchingButton=true` in your `config.toml` + +```toml +[params] + # When using mulitlingual website, disable the switch language button. + disableLanguageSwitchingButton = true +``` + +![I18n menu](/en/cont/i18n/images/i18n-menu.gif) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.fr.md new file mode 100644 index 000000000..6503abf4c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/_index.fr.md @@ -0,0 +1,78 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Multi-langue et i18n +weight: 30 +--- + +**Learn** est complètement compatible avec le mode multi-langue d'Hugo. + +Il fournit : + +- Des *translation strings* pour les valeurs par défaut utilisées par le thème (Anglais et Français). N'hésitez pas à contribuer ! +- Génération automatique du menu avec le contenu multi-langue +- Modification de la langue dans le navigateur + +![I18n menu](/en/cont/i18n/images/i18n-menu.gif) + +## Configuration simple + +Après avoir appris [comment Hugo gère les sites multi-langue](https://gohugo.io/content-management/multilingual), définissez vos langues dans votre fichier `config.toml`. + +Par exemple, pour ce site, avec du contenu en français et en anglais. + +```toml +# Anglais est la langue par défaut +defaultContentLanguage = "en" +# Force d'avoir /en/ma-page et /fr/ma-page routes, même avec la langue par défaut. +defaultContentLanguageInSubdir= true + +[Languages] +[Languages.en] +title = "Documentation for Hugo Learn Theme" +weight = 1 +languageName = "English" + +[Languages.fr] +title = "Documentation du thème Hugo Learn" +weight = 2 +languageName = "Français" +``` + +Puis, pour chaque nouvelle page, ajoutez *l'id* de la langue du fichier. + +- Le fichier `my-page.md` est découpé en deux fichiers : + - en anglais : `my-page.en.md` + - en français : `my-page.fr.md` +- Le fichier `_index.md` est découpé en deux fichiers : + - en anglais: `_index.en.md` + - en français: `_index.fr.md` + +{{% notice info %}} +Attention, seulement les pages traduites sont affichées dans le menu. Le contenu n'est pas remplacé par les pages de la langue par défaut. +{{% /notice %}} + +{{% notice tip %}} +Utilisez le paramètre du Front Matter [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) pour traduire également les URLs. +{{% /notice %}} + +## Surcharger les *translation strings* + +Les *Translations strings* sont utilisées comme valeurs par défaut dans le thème (Bouton *Modifier la page*, Element de subsitution *Recherche*, etc.). Les traductions sont disponibles en français et en anglais mais vous pouvez utiliser n'importe quelle autre langue et surcharger avec vos propres valeurs. + +Pour surcharger ces valeurs, créer un nouveau fichier dans votre dossier i18n local `i18n/.toml` et inspirez vous du thème `themes/hugo-theme-learn/i18n/en.toml` + +D'ailleurs, ces traductions pour servir à tout le monde, donc svp prenez le temps de [proposer une Pull Request](https://github.com/matcornic/hugo-theme-learn/pulls) ! + +## Désactiver le changement de langue + +Vous pouvez changer de langue directement dans le navigateur. C'est une super fonctionnalité, mais vous avez peut-être besoin de la désactiver. + +Pour ce faire, ajouter le paramètre `disableLanguageSwitchingButton=true` dans votre `config.toml` + +```toml +[params] + # Quand vous utilisez un site en multi-langue, désactive le bouton de changment de langue. + disableLanguageSwitchingButton = true +``` + +![I18n menu](/en/cont/i18n/images/i18n-menu.gif) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/images/i18n-menu.gif b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/images/i18n-menu.gif new file mode 100644 index 000000000..99ee22267 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/i18n/images/i18n-menu.gif differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/icons.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/icons.en.md new file mode 100644 index 000000000..ad769c6c1 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/icons.en.md @@ -0,0 +1,41 @@ +--- +title: Icons and logos +weight: 27 +--- + +The Learn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com) library, allowing you to easily display any icon or logo available in the Font Awesome free collection. + +## Finding an icon + +Browse through the available icons in the [Font Awesome Gallery](https://fontawesome.com/icons?d=gallery&m=free). Notice that the **free** filter is enabled, as only the free icons are available by default. + +Once on the Font Awesome page for a specific icon, for example the page for the [heart](https://fontawesome.com/icons/heart?style=solid), copy the HTML reference and paste into the markdown content. + +The HTML to include the heart icon is: + +``` + +``` + +## Including in markdown + +Paste the `` HTML into markup and Font Awesome will load the relevant icon. + +``` +Built with from Grav and Hugo +``` + +Which appears as + +Built with from Grav and Hugo + +## Customising icons + +Font Awesome provides many ways to modify the icon + +* Change colour (by default the icon will inherit the parent colour) +* Increase or decrease size +* Rotate +* Combine with other icons + +Check the full documentation on [web fonts with CSS](https://fontawesome.com/how-to-use/web-fonts-with-css) for more. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.en.md new file mode 100644 index 000000000..c97701e01 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.en.md @@ -0,0 +1,692 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Markdown syntax +weight: 15 +--- + +{{% notice note %}} +This page is a shameful copy of the great [Grav original page](http://learn.getgrav.org/content/markdown). +Only difference is information about image customization ([resizing]({{< relref "#resizing-image" >}}), [add CSS classes]({{< relref "#add-css-classes" >}})...) +{{% /notice%}} + +Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages. + +**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it. + +Some of the key benefits are: + +1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content. +2. Less chance of errors when writing in markdown. +3. Produces valid XHTML output. +4. Keeps the content and the visual display separate, so you cannot mess up the look of your site. +5. Write in any text editor or Markdown application you like. +6. Markdown is a joy to use! + +John Gruber, the author of Markdown, puts it like this: + +> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. +> -- John Gruber + +Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file + +Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like: + +{{% notice info %}} + Bookmark this page for easy future reference! +{{% /notice %}} + +## Headings + +Headings from `h1` through `h6` are constructed with a `#` for each level: + +```markdown +# h1 Heading +## h2 Heading +### h3 Heading +#### h4 Heading +##### h5 Heading +###### h6 Heading +``` + +Renders to: + +# h1 Heading + + +## h2 Heading + +### h3 Heading + +#### h4 Heading + +##### h5 Heading + +###### h6 Heading + +HTML: + +```html +

h1 Heading

+

h2 Heading

+

h3 Heading

+

h4 Heading

+
h5 Heading
+
h6 Heading
+``` + +## Comments + +Comments should be HTML compatible + +```html + +``` + +Comment below should **NOT** be seen: + + + +## Horizontal Rules + +The HTML `
` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `
` with any of the following: + +* `___`: three consecutive underscores +* `---`: three consecutive dashes +* `***`: three consecutive asterisks + +renders to: + +___ + +## Body Copy + +Body copy written as normal, plain text will be wrapped with `

` tags in the rendered HTML. + +So this body copy: + +```markdown +Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. +``` + +renders to this HTML: + +```html +

Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.

+``` + +## Emphasis + +### Bold + +For emphasizing a snippet of text with a heavier font-weight. + +The following snippet of text is **rendered as bold text**. + +```markdown +**rendered as bold text** +``` + +renders to: + + +**rendered as bold text** + + +and this HTML + +```html +rendered as bold text +``` + +### Italics + +For emphasizing a snippet of text with italics. + +The following snippet of text is _rendered as italicized text_. + +```markdown +_rendered as italicized text_ +``` + +renders to: + + +_rendered as italicized text_ + + +and this HTML: + +```html +rendered as italicized text +``` + +### Strikethrough + +In GFM (GitHub flavored Markdown) you can do strikethroughs. + +```markdown +~~Strike through this text.~~ +``` + +Which renders to: + +~~Strike through this text.~~ + +HTML: + +```html +Strike through this text. +``` + +## Blockquotes + +For quoting blocks of content from another source within your document. + +Add `>` before any text you want to quote. + +```markdown +> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. +``` + +Renders to: + +> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. + +and this HTML: + +```html +
+

Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.

+
+``` + +Blockquotes can also be nested: + +```markdown +> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. +> +> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. +> +> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. +``` + +Renders to: + +> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. +> +> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. +> +> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. + +## Notices + +{{% notice note %}} +The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) +{{% /notice %}} + +## Lists + +### Unordered + +A list of items in which the order of the items does not explicitly matter. + +You may use any of the following symbols to denote bullets for each list item: + +```markdown +* valid bullet +- valid bullet ++ valid bullet +``` + +For example + +```markdown ++ Lorem ipsum dolor sit amet ++ Consectetur adipiscing elit ++ Integer molestie lorem at massa ++ Facilisis in pretium nisl aliquet ++ Nulla volutpat aliquam velit + - Phasellus iaculis neque + - Purus sodales ultricies + - Vestibulum laoreet porttitor sem + - Ac tristique libero volutpat at ++ Faucibus porta lacus fringilla vel ++ Aenean sit amet erat nunc ++ Eget porttitor lorem +``` + +Renders to: + + ++ Lorem ipsum dolor sit amet ++ Consectetur adipiscing elit ++ Integer molestie lorem at massa ++ Facilisis in pretium nisl aliquet ++ Nulla volutpat aliquam velit + - Phasellus iaculis neque + - Purus sodales ultricies + - Vestibulum laoreet porttitor sem + - Ac tristique libero volutpat at ++ Faucibus porta lacus fringilla vel ++ Aenean sit amet erat nunc ++ Eget porttitor lorem + + +And this HTML + +```html +
    +
  • Lorem ipsum dolor sit amet
    • +
  • Consectetur adipiscing elit
    • +
  • Integer molestie lorem at massa
    • +
  • Facilisis in pretium nisl aliquet
    • +
  • Nulla volutpat aliquam velit +
      +
    • Phasellus iaculis neque
      • +
    • Purus sodales ultricies
      • +
    • Vestibulum laoreet porttitor sem
      • +
    • Ac tristique libero volutpat at
      • +
    +
    • +
  • Faucibus porta lacus fringilla vel
    • +
  • Aenean sit amet erat nunc
    • +
  • Eget porttitor lorem
    • +
+``` + +### Ordered + +A list of items in which the order of items does explicitly matter. + +```markdown +1. Lorem ipsum dolor sit amet +4. Consectetur adipiscing elit +2. Integer molestie lorem at massa +8. Facilisis in pretium nisl aliquet +4. Nulla volutpat aliquam velit +99. Faucibus porta lacus fringilla vel +21. Aenean sit amet erat nunc +6. Eget porttitor lorem +``` + +Renders to: + +1. Lorem ipsum dolor sit amet +2. Consectetur adipiscing elit +3. Integer molestie lorem at massa +4. Facilisis in pretium nisl aliquet +5. Nulla volutpat aliquam velit +6. Faucibus porta lacus fringilla vel +7. Aenean sit amet erat nunc +8. Eget porttitor lorem + +And this HTML: + +```html +
    +
  1. Lorem ipsum dolor sit amet
    2. +
  2. Consectetur adipiscing elit
    3. +
  3. Integer molestie lorem at massa
    4. +
  4. Facilisis in pretium nisl aliquet
    5. +
  5. Nulla volutpat aliquam velit
    6. +
  6. Faucibus porta lacus fringilla vel
    7. +
  7. Aenean sit amet erat nunc
    8. +
  8. Eget porttitor lorem
    9. +
+``` + +**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example: + +```markdown +1. Lorem ipsum dolor sit amet +1. Consectetur adipiscing elit +1. Integer molestie lorem at massa +1. Facilisis in pretium nisl aliquet +1. Nulla volutpat aliquam velit +1. Faucibus porta lacus fringilla vel +1. Aenean sit amet erat nunc +1. Eget porttitor lorem +``` + +Renders to: + +1. Lorem ipsum dolor sit amet +2. Consectetur adipiscing elit +3. Integer molestie lorem at massa +4. Facilisis in pretium nisl aliquet +5. Nulla volutpat aliquam velit +6. Faucibus porta lacus fringilla vel +7. Aenean sit amet erat nunc +8. Eget porttitor lorem + +## Code + +### Inline code + +Wrap inline snippets of code with `` ` ``. + +```markdown +In this example, `
` should be wrapped as **code**. +``` + +Renders to: + +In this example, `
` should be wrapped as **code**. + +HTML: + +```html +

In this example, <section></section> should be wrapped as code.

+``` + +### Indented code + +Or indent several lines of code by at least two spaces, as in: + +```markdown + // Some comments + line 1 of code + line 2 of code + line 3 of code +``` + +Renders to: + + + // Some comments + line 1 of code + line 2 of code + line 3 of code + + +HTML: + +```html +
+  
+    // Some comments
+    line 1 of code
+    line 2 of code
+    line 3 of code
+  
+
+``` + +### Block code "fences" + +Use "fences" ```` ``` ```` to block in multiple lines of code. + +```markdown +Sample text here... +``` + +HTML: + +```html +
+  Sample text here...
+
+``` + +### Syntax highlighting + +GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. + +See [Code Highlighting]({{< ref "syntaxhighlight.md" >}}) for additional documentation. + +For example, to apply syntax highlighting to JavaScript code: + +```plaintext + ```js + grunt.initConfig({ + assemble: { + options: { + assets: 'docs/assets', + data: 'src/data/*.{json,yml}', + helpers: 'src/custom-helpers.js', + partials: ['src/partials/**/*.{hbs,md}'] + }, + pages: { + options: { + layout: 'default.hbs' + }, + files: { + './': ['src/templates/pages/index.hbs'] + } + } + } + }; + ``` +``` + +Renders to: + +```js +grunt.initConfig({ + assemble: { + options: { + assets: 'docs/assets', + data: 'src/data/*.{json,yml}', + helpers: 'src/custom-helpers.js', + partials: ['src/partials/**/*.{hbs,md}'] + }, + pages: { + options: { + layout: 'default.hbs' + }, + files: { + './': ['src/templates/pages/index.hbs'] + } + } + } +}; +``` + +## Tables + +Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. + +```markdown +| Option | Description | +| ------ | ----------- | +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | +``` + +Renders to: + +| Option | Description | +| ------ | ----------- | +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | + +And this HTML: + +```html + + + + + + + + + + + + + + + + + +
OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.
+``` + +### Right aligned text + +Adding a colon on the right side of the dashes below any heading will right align text for that column. + +```markdown +| Option | Description | +| ------:| -----------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | +``` + +| Option | Description | +| ------:| -----------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | + +## Links + +### Basic link + +```markdown +[Assemble](http://assemble.io) +``` + +Renders to (hover over the link, there is no tooltip): + +[Assemble](http://assemble.io) + +HTML: + +```html +Assemble +``` + +### Add a tooltip + +```markdown +[Upstage](https://github.com/upstage/ "Visit Upstage!") +``` + +Renders to (hover over the link, there should be a tooltip): + +[Upstage](https://github.com/upstage/ "Visit Upstage!") + +HTML: + +```html +Upstage +``` + +### Named Anchors + +Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters: + +```markdown +# Table of Contents + * [Chapter 1](#chapter-1) + * [Chapter 2](#chapter-2) + * [Chapter 3](#chapter-3) +``` + +will jump to these sections: + +```markdown +## Chapter 1 +Content for chapter one. + +## Chapter 2 +Content for chapter one. + +## Chapter 3 +Content for chapter one. +``` +**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works. + +## Images {#images} +Images have a similar syntax to links but include a preceding exclamation point. + +```markdown +![Minion](https://octodex.github.com/images/minion.png) +``` + +![Minion](https://octodex.github.com/images/minion.png) + +or + +```markdown +![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") +``` + +![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") + +Like links, Images also have a footnote style syntax + +### Alternative usage : note images + +```markdown +![Alt text][id] +``` + +![Alt text][id] + +With a reference later in the document defining the URL location: + +[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" + + [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" + +### Resizing image + +Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`). + +```markdown +![Minion](https://octodex.github.com/images/minion.png?width=20pc) +``` + +![Minion](https://octodex.github.com/images/minion.png?width=20pc) + +```markdown +![Minion](https://octodex.github.com/images/minion.png?height=50px) +``` + +![Minion](https://octodex.github.com/images/minion.png?height=50px) + +```markdown +![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px) +``` + +![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px) + +### Add CSS classes + +Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones. + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) +``` + +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow) + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) +``` + +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border) + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) +``` + +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow) + +### Lightbox + +Add a HTTP `featherlight` parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining `featherlight` to `false`. + +```markdown +![Minion](https://octodex.github.com/images/minion.png?featherlight=false) +``` diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.fr.md new file mode 100644 index 000000000..e734b31cd --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/markdown.fr.md @@ -0,0 +1,666 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Syntaxe Markdown +weight: 15 +--- + +{{% notice note %}} +Cette page est une copie de la [doc de Grav](http://learn.getgrav.org/content/markdown). +La seule différence porte sur la personalisation des images ([taille]({{< relref "#resizing-image" >}}), [ajout de classes CSS]({{< relref "#add-css-classes" >}})...) +Pour des raisons évidentes, cette page n'a pas été traduites en français 😁 +{{% /notice%}} + +Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages. + +**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it. + +Some of the key benefits are: + +1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content. +2. Less chance of errors when writing in markdown. +3. Produces valid XHTML output. +4. Keeps the content and the visual display separate, so you cannot mess up the look of your site. +5. Write in any text editor or Markdown application you like. +6. Markdown is a joy to use! + +John Gruber, the author of Markdown, puts it like this: + +> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. +> -- John Gruber + + +Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file + +Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like: + +{{% notice info %}} + Bookmark this page for easy future reference! +{{% /notice %}} + +## Headings + +Headings from `h1` through `h6` are constructed with a `#` for each level: + +```markdown +# h1 Heading +## h2 Heading +### h3 Heading +#### h4 Heading +##### h5 Heading +###### h6 Heading +``` + +Renders to: + +# h1 Heading +## h2 Heading +### h3 Heading +#### h4 Heading +##### h5 Heading +###### h6 Heading + +HTML: + +```html +

h1 Heading

+

h2 Heading

+

h3 Heading

+

h4 Heading

+
h5 Heading
+
h6 Heading
+``` + +## Comments + +Comments should be HTML compatible + +```html + +``` +Comment below should **NOT** be seen: + + + + +## Horizontal Rules + +The HTML `
` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `
` with any of the following: + +* `___`: three consecutive underscores +* `---`: three consecutive dashes +* `***`: three consecutive asterisks + +renders to: + +___ + +--- + +*** + + +## Body Copy + +Body copy written as normal, plain text will be wrapped with `

` tags in the rendered HTML. + +So this body copy: + +```markdown +Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. +``` +renders to this HTML: + +```html +

Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.

+``` + +## Emphasis + +### Bold +For emphasizing a snippet of text with a heavier font-weight. + +The following snippet of text is **rendered as bold text**. + +```markdown +**rendered as bold text** +``` +renders to: + +**rendered as bold text** + +and this HTML + +```html +rendered as bold text +``` + +### Italics +For emphasizing a snippet of text with italics. + +The following snippet of text is _rendered as italicized text_. + +```markdown +_rendered as italicized text_ +``` + +renders to: + +_rendered as italicized text_ + +and this HTML: + +```html +rendered as italicized text +``` + + +### strikethrough +In GFM (GitHub flavored Markdown) you can do strikethroughs. + +```markdown +~~Strike through this text.~~ +``` +Which renders to: + +~~Strike through this text.~~ + +HTML: + +```html +Strike through this text. +``` + +## Blockquotes + +For quoting blocks of content from another source within your document. + +Add `>` before any text you want to quote. + +```markdown +> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. +``` + +Renders to: + +> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. + +and this HTML: + +```html +
+

Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.

+
+``` + +Blockquotes can also be nested: + +```markdown +> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. +> +> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. +> +> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. +``` + +Renders to: + +> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. +> +> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. +> +> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. + +## Notices + +{{% notice note %}} +The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) +{{% /notice %}} + +## Lists + +### Unordered +A list of items in which the order of the items does not explicitly matter. + +You may use any of the following symbols to denote bullets for each list item: + +```markdown +* valid bullet +- valid bullet ++ valid bullet +``` + +For example + +```markdown ++ Lorem ipsum dolor sit amet ++ Consectetur adipiscing elit ++ Integer molestie lorem at massa ++ Facilisis in pretium nisl aliquet ++ Nulla volutpat aliquam velit + - Phasellus iaculis neque + - Purus sodales ultricies + - Vestibulum laoreet porttitor sem + - Ac tristique libero volutpat at ++ Faucibus porta lacus fringilla vel ++ Aenean sit amet erat nunc ++ Eget porttitor lorem +``` +Renders to: + ++ Lorem ipsum dolor sit amet ++ Consectetur adipiscing elit ++ Integer molestie lorem at massa ++ Facilisis in pretium nisl aliquet ++ Nulla volutpat aliquam velit + - Phasellus iaculis neque + - Purus sodales ultricies + - Vestibulum laoreet porttitor sem + - Ac tristique libero volutpat at ++ Faucibus porta lacus fringilla vel ++ Aenean sit amet erat nunc ++ Eget porttitor lorem + +And this HTML + +```html +
    +
  • Lorem ipsum dolor sit amet
    • +
  • Consectetur adipiscing elit
    • +
  • Integer molestie lorem at massa
    • +
  • Facilisis in pretium nisl aliquet
    • +
  • Nulla volutpat aliquam velit +
      +
    • Phasellus iaculis neque
      • +
    • Purus sodales ultricies
      • +
    • Vestibulum laoreet porttitor sem
      • +
    • Ac tristique libero volutpat at
      • +
    +
    • +
  • Faucibus porta lacus fringilla vel
    • +
  • Aenean sit amet erat nunc
    • +
  • Eget porttitor lorem
    • +
+``` + +### Ordered + +A list of items in which the order of items does explicitly matter. + +```markdown +1. Lorem ipsum dolor sit amet +2. Consectetur adipiscing elit +3. Integer molestie lorem at massa +4. Facilisis in pretium nisl aliquet +5. Nulla volutpat aliquam velit +6. Faucibus porta lacus fringilla vel +7. Aenean sit amet erat nunc +8. Eget porttitor lorem +``` +Renders to: + +1. Lorem ipsum dolor sit amet +2. Consectetur adipiscing elit +3. Integer molestie lorem at massa +4. Facilisis in pretium nisl aliquet +5. Nulla volutpat aliquam velit +6. Faucibus porta lacus fringilla vel +7. Aenean sit amet erat nunc +8. Eget porttitor lorem + +And this HTML: + +```html +
    +
  1. Lorem ipsum dolor sit amet
    2. +
  2. Consectetur adipiscing elit
    3. +
  3. Integer molestie lorem at massa
    4. +
  4. Facilisis in pretium nisl aliquet
    5. +
  5. Nulla volutpat aliquam velit
    6. +
  6. Faucibus porta lacus fringilla vel
    7. +
  7. Aenean sit amet erat nunc
    8. +
  8. Eget porttitor lorem
    9. +
+``` + +**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example: + +```markdown +1. Lorem ipsum dolor sit amet +1. Consectetur adipiscing elit +1. Integer molestie lorem at massa +1. Facilisis in pretium nisl aliquet +1. Nulla volutpat aliquam velit +1. Faucibus porta lacus fringilla vel +1. Aenean sit amet erat nunc +1. Eget porttitor lorem +``` + +Renders to: + +1. Lorem ipsum dolor sit amet +2. Consectetur adipiscing elit +3. Integer molestie lorem at massa +4. Facilisis in pretium nisl aliquet +5. Nulla volutpat aliquam velit +6. Faucibus porta lacus fringilla vel +7. Aenean sit amet erat nunc +8. Eget porttitor lorem + +## Code + +### Inline code +Wrap inline snippets of code with `` ` ``. + +```markdown +In this example, `
` should be wrapped as **code**. +``` + +Renders to: + +In this example, `
` should be wrapped with **code**. + +HTML: + +```html +

In this example, <section></section> should be wrapped with code.

+``` + +### Indented code + +Or indent several lines of code by at least four spaces, as in: + +
+  // Some comments
+  line 1 of code
+  line 2 of code
+  line 3 of code
+
+ +Renders to: + + // Some comments + line 1 of code + line 2 of code + line 3 of code + +HTML: + +```html +
+  
+    // Some comments
+    line 1 of code
+    line 2 of code
+    line 3 of code
+  
+
+``` + + +### Block code "fences" + +Use "fences" ```` ``` ```` to block in multiple lines of code. + +
+``` markup
+Sample text here...
+```
+
+ + +``` +Sample text here... +``` + +HTML: + +```html +
+  Sample text here...
+
+``` + +### Syntax highlighting + +GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code: + +
+```js
+grunt.initConfig({
+  assemble: {
+    options: {
+      assets: 'docs/assets',
+      data: 'src/data/*.{json,yml}',
+      helpers: 'src/custom-helpers.js',
+      partials: ['src/partials/**/*.{hbs,md}']
+    },
+    pages: {
+      options: {
+        layout: 'default.hbs'
+      },
+      files: {
+        './': ['src/templates/pages/index.hbs']
+      }
+    }
+  }
+};
+```
+
+ +Renders to: + +```js +grunt.initConfig({ + assemble: { + options: { + assets: 'docs/assets', + data: 'src/data/*.{json,yml}', + helpers: 'src/custom-helpers.js', + partials: ['src/partials/**/*.{hbs,md}'] + }, + pages: { + options: { + layout: 'default.hbs' + }, + files: { + './': ['src/templates/pages/index.hbs'] + } + } + } +}; +``` + +## Tables +Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. + + +```markdown +| Option | Description | +| ------ | ----------- | +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | +``` + +Renders to: + +| Option | Description | +| ------ | ----------- | +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | + +And this HTML: + +```html + + + + + + + + + + + + + + + + + +
OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.
+``` + +### Right aligned text + +Adding a colon on the right side of the dashes below any heading will right align text for that column. + +```markdown +| Option | Description | +| ------:| -----------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | +``` + +| Option | Description | +| ------:| -----------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | + +## Links + +### Basic link + +```markdown +[Assemble](http://assemble.io) +``` + +Renders to (hover over the link, there is no tooltip): + +[Assemble](http://assemble.io) + +HTML: + +```html +Assemble +``` + + +### Add a title + +```markdown +[Upstage](https://github.com/upstage/ "Visit Upstage!") +``` + +Renders to (hover over the link, there should be a tooltip): + +[Upstage](https://github.com/upstage/ "Visit Upstage!") + +HTML: + +```html +Upstage +``` + +### Named Anchors + +Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters: + +```markdown +# Table of Contents + * [Chapter 1](#chapter-1) + * [Chapter 2](#chapter-2) + * [Chapter 3](#chapter-3) +``` +will jump to these sections: + +```markdown +## Chapter 1 +Content for chapter one. + +## Chapter 2 +Content for chapter one. + +## Chapter 3 +Content for chapter one. +``` +**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works. + + +## Images {#images} +Images have a similar syntax to links but include a preceding exclamation point. + +```markdown +![Minion](https://octodex.github.com/images/minion.png) +``` +![Minion](https://octodex.github.com/images/minion.png) + +or +```markdown +![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") +``` +![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") + +Like links, Images also have a footnote style syntax + +### Alternative usage : note images + +```markdown +![Alt text][id] +``` +![Alt text][id] + +With a reference later in the document defining the URL location: + +[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" + + [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" + +### Resizing image + +Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`). + +```markdown +![Minion](https://octodex.github.com/images/minion.png?width=20pc) +``` + +![Minion](https://octodex.github.com/images/minion.png?width=20pc) + +```markdown +![Minion](https://octodex.github.com/images/minion.png?height=50px) +``` + +![Minion](https://octodex.github.com/images/minion.png?height=50px) + +```markdown +![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px) +``` + +![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px) + +### Add CSS classes + +Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones. + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) +``` +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow) + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) +``` +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border) + +```markdown +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) +``` +![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.en.md new file mode 100644 index 000000000..e59d6fdb6 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.en.md @@ -0,0 +1,109 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Menu extra shortcuts +weight: 25 +--- + +You can define additional menu entries or shortcuts in the navigation menu without any link to content. + +## Basic configuration + +Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add. + +Example from the current website: + + [[menu.shortcuts]] + name = " Github repo" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[menu.shortcuts]] + name = " Showcases" + url = "/showcase" + weight = 11 + + [[menu.shortcuts]] + name = " Hugo Documentation" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[menu.shortcuts]] + name = " Credits" + url = "/credits" + weight = 30 + +By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`. +However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration. + +For example, in your local `i18n/en.toml` file, add the following content + + [Shortcuts-Title] + other = "" + +Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo i18n translation strings](https://gohugo.io/content-management/multilingual/#translation-of-strings) + +## Configuration for Multilingual mode {#i18n} + +When using a multilingual website, you can set different menus for each language. In the `config.toml` file, prefix your menu configuration by `Languages.`. + + +Example from the current website: + + [Languages] + [Languages.en] + title = "Documentation for Hugo Learn Theme" + weight = 1 + languageName = "English" + + [[Languages.en.menu.shortcuts]] + name = " Github repo" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[Languages.en.menu.shortcuts]] + name = " Showcases" + url = "/showcase" + weight = 11 + + [[Languages.en.menu.shortcuts]] + name = " Hugo Documentation" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[Languages.en.menu.shortcuts]] + name = " Credits" + url = "/credits" + weight = 30 + + [Languages.fr] + title = "Documentation du thème Hugo Learn" + weight = 2 + languageName = "Français" + + [[Languages.fr.menu.shortcuts]] + name = " Repo Github" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[Languages.fr.menu.shortcuts]] + name = " Vitrine" + url = "/showcase" + weight = 11 + + [[Languages.fr.menu.shortcuts]] + name = " Documentation Hugo" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[Languages.fr.menu.shortcuts]] + name = " Crédits" + url = "/credits" + weight = 30 + +Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo multilingual menus](https://gohugo.io/content-management/multilingual/#menus) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.fr.md new file mode 100644 index 000000000..886067906 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/menushortcuts.fr.md @@ -0,0 +1,109 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Raccourcis du menu +weight: 25 +--- + +Vous pouvez définir des entrées ou raccourcis supplémentaires dans le menu sans avoir besoin d'être lié à un contenu du site. + +## Configuration simple + +Editez le fichier de configuration `config.toml` et ajoutez une entrée `[[menu.shortcuts]]` pour chaque lien que vous voulez ajouter. + +Exemple pour ce site: + + [[menu.shortcuts]] + name = " Github repo" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[menu.shortcuts]] + name = " Showcases" + url = "/showcase" + weight = 11 + + [[menu.shortcuts]] + name = " Hugo Documentation" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[menu.shortcuts]] + name = " Credits" + url = "/credits" + weight = 30 + +Par défaut, les raccourcis sont précédés par un titre. Ce titre peut être désactivé en ajouter le paramètre `disableShortcutsTitle=true` dans la section `params` de votre `config.toml`. +Cependant, si vous voulez garder le titre mais changer sa valeur, vous pouvez modifier votre configuration multilangue locale en changeant les *translation string*. + +Par exemple, dans votre fichier local `i18n/en.toml`, ajouter le contenu + + [Shortcuts-Title] + other = "" + +Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et sur [les translations strings](https://gohugo.io/content-management/multilingual/#translation-of-strings) + +## Configuration pour le mode multi-langue {#i18n} + +Quand vous utilisez un site multi-langue, vous pouvez avoir des menus différents pour chaque langage. Dans le fichier de configuration `config.toml`, préfixez votre configuration par `Languages.`. + + +Par exemple, avec ce site : + + [Languages] + [Languages.en] + title = "Documentation for Hugo Learn Theme" + weight = 1 + languageName = "English" + + [[Languages.en.menu.shortcuts]] + name = " Github repo" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[Languages.en.menu.shortcuts]] + name = " Showcases" + url = "/showcase" + weight = 11 + + [[Languages.en.menu.shortcuts]] + name = " Hugo Documentation" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[Languages.en.menu.shortcuts]] + name = " Credits" + url = "/credits" + weight = 30 + + [Languages.fr] + title = "Documentation du thème Hugo Learn" + weight = 2 + languageName = "Français" + + [[Languages.fr.menu.shortcuts]] + name = " Repo Github" + identifier = "ds" + url = "https://github.com/matcornic/hugo-theme-learn" + weight = 10 + + [[Languages.fr.menu.shortcuts]] + name = " Vitrine" + url = "/showcase" + weight = 11 + + [[Languages.fr.menu.shortcuts]] + name = " Documentation Hugo" + identifier = "hugodoc" + url = "https://gohugo.io/" + weight = 20 + + [[Languages.fr.menu.shortcuts]] + name = " Crédits" + url = "/credits" + weight = 30 + +Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et les [menus multi-langue Hugo](https://gohugo.io/content-management/multilingual/#menus) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.en.md new file mode 100644 index 000000000..ad6a1b5a8 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.en.md @@ -0,0 +1,166 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Pages organization +weight: 5 +--- + +In **Hugo**, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site. + +## Folders + +Organize your site like [any other Hugo project](https://gohugo.io/content/organization/). Typically, you will have a *content* folder with all your pages. + + content + ├── level-one + │ ├── level-two + │ │ ├── level-three + │ │ │ ├── level-four + │ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four + │ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a + │ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b + │ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c + │ │ │ ├── _index.md <-- /level-one/level-two/level-three + │ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a + │ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b + │ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c + │ │ ├── _index.md <-- /level-one/level-two + │ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a + │ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b + │ │ └── page-2-c.md <-- /level-one/level-two/page-2-c + │ ├── _index.md <-- /level-one + │ ├── page-1-a.md <-- /level-one/page-1-a + │ ├── page-1-b.md <-- /level-one/page-1-b + │ └── page-1-c.md <-- /level-one/page-1-c + ├── _index.md <-- / + └── page-top.md <-- /page-top + +{{% notice note %}} +`_index.md` is required in each folder, it’s your “folder home page” +{{% /notice %}} + +## Types + +**Hugo-theme-learn** defines two types of pages. *Default* and *Chapter*. Both can be used at any level of the documentation, the only difference being layout display. + +A **Chapter** displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it. +You can define any HTML as prefix for the menu. In the example below, it's just a number but that could be an [icon](https://fortawesome.github.io/Font-Awesome/). + +![Chapter page](/en/cont/pages/images/pages-chapter.png?width=50pc) + +```markdown ++++ +title = "Basics" +chapter = true +weight = 5 +pre = "1. " ++++ + +### Chapter 1 + +# Basics + +Discover what this Hugo theme is all about and the core-concepts behind it. +``` + +To tell **Hugo-theme-learn** to consider a page as a chapter, set `chapter=true` in the Front Matter of the page. + +A **Default** page is any other content page. + +![Default page](/en/cont/pages/images/pages-default.png?width=50pc) + +```toml ++++ +title = "Installation" +weight = 15 ++++ +``` + +The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/). + +## Create your project + +Hugo provides a `new` command to create a new website. + +``` +hugo new site +``` + +**Hugo-theme-learn** provides [archetypes]({{< relref "cont/archetypes.en.md" >}}) to help you create this kind of pages. + +## Front Matter configuration + +Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *yaml*, *toml* or *json*. + +**Hugo-theme-learn** uses the following parameters on top of Hugo ones : + +```toml ++++ +# Table of content (toc) is enabled by default. Set this parameter to true to disable it. +# Note: Toc is always disabled for chapter pages +disableToc = "false" +# If set, this will be used for the page's menu entry (instead of the `title` attribute) +menuTitle = "" +# The title of the page in menu will be prefixed by this HTML content +pre = "" +# The title of the page in menu will be postfixed by this HTML content +post = "" +# Set the page as a chapter, changing the way it's displayed +chapter = false +# Hide a menu entry by setting this to true +hidden = false +# Display name of this page modifier. If set, it will be displayed in the footer. +LastModifierDisplayName = "" +# Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer +LastModifierEmail = "" ++++ +``` + +### Add icon to a menu entry + +In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the Github icon. + +```toml ++++ +title = "Github repo" +pre = " " ++++ +``` + +![Title with icon](/en/cont/pages/images/frontmatter-icon.png) + +### Ordering sibling menu/page entries + +Hugo provides a [flexible way](https://gohugo.io/content/ordering/) to handle order for your pages. + +The simplest way is to set `weight` parameter to a number. + +```toml ++++ +title = "My page" +weight = 5 ++++ +``` + +### Using a custom title for menu entries + +By default, **Hugo-theme-learn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined). + +But a page's title has to be descriptive on its own while the menu is a hierarchy. +We've added the `menuTitle` parameter for that purpose: + +For example (for a page named `content/install/linux.md`): + +```toml ++++ +title = "Install on Linux" +menuTitle = "Linux" ++++ +``` + +## Homepage + +To configure your home page, you basically have three choices: + +1. Create an `_index.md` document in `content` folder and fill the file with *Markdown content* +2. Create an `index.html` file in the `static` folder and fill the file with *HTML content* +3. Configure your server to automatically redirect home page to one your documentation page diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.fr.md new file mode 100644 index 000000000..50c6f256b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/_index.fr.md @@ -0,0 +1,146 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Organisation des pages +weight: 5 +--- + +Dans **Hugo**, les pages sont le cœur de votre site. Une fois configurées, les pages sont la valeur ajoutée de votre site de documentation. + +## Dossiers + +Organisez votre site comme n'importe quel autre [projet Hugo](https://gohugo.io/content/organization/). Typiquement, vous allez avoir un dossier *content* avec vos pages. + + content + ├── niveau-un + │ ├── niveau-deux + │ │ ├── niveau-trois + │ │ │ ├── niveau-quatre + │ │ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre + │ │ │ │ ├── page-4-a.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-a + │ │ │ │ ├── page-4-b.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-b + │ │ │ │ └── page-4-c.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-c + │ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois + │ │ │ ├── page-3-a.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-a + │ │ │ ├── page-3-b.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-b + │ │ │ └── page-3-c.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-c + │ │ ├── _index.md <-- /niveau-un/niveau-deux + │ │ ├── page-2-a.md <-- /niveau-un/niveau-deux/page-2-a + │ │ ├── page-2-b.md <-- /niveau-un/niveau-deux/page-2-b + │ │ └── page-2-c.md <-- /niveau-un/niveau-deux/page-2-c + │ ├── _index.md <-- /niveau-un + │ ├── page-1-a.md <-- /niveau-un/page-1-a + │ ├── page-1-b.md <-- /niveau-un/page-1-b + │ └── page-1-c.md <-- /niveau-un/page-1-c + ├── _index.md <-- / + └── premiere-page.md <-- /premiere-page + +{{% notice note %}} +Le fichier `_index.md` est obligatoire dans chaque dossier, c'est en quelque sorte votre page d'accueil pour le dossier. +{{% /notice %}} + +## Types + +**Hugo-theme-learn** définit deux types de pages. *Défaut* et *Chapitre*. Les deux sont utilisables à n'importe quel niveau du site, la seule différence est dans l'affichage. + +Un **Chapitre** affiche une page vouée à être une introduction pour un ensemble de pages filles. Habituellement, il va seulement contenir un titre et un résumé de la section. +Vous pouvez définir n'importe quel contenu HTML comme préfixe de l'entrée du menu. Dans l'exemple ci-dessous, c'est juste un nombre mais vous pourriez utiliser une [icône](https://fortawesome.github.io/Font-Awesome/). + +![Page Chapitre](/en/cont/pages/images/pages-chapter.png?width=50pc) + +```markdown ++++ +title = "Démarrage" +weight = 5 +pre = "1. " +chapter = true ++++ + +### Chapitre 1 + +# Démarrage + +Découvrez comment utiliser ce thème Hugo et apprenez en les concepts +``` + +Pour dire à **Hugo-theme-learn** de considérer la page comme un chapitre, configure `chapter=true` dans le Front Matter de la page. + +Une page **Défaut** est n'importe quelle autre page. + +![Page défaut](/en/cont/pages/images/pages-default.png?width=50pc) + + +++ + title = "Installation" + weight = 15 + +++ + + The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/). + + ## Create your project + + Hugo provides a `new` command to create a new website. + + ``` + hugo new site + ``` + +**Hugo-theme-learn** fournit des [archétypes]({{< relref "cont/archetypes.fr.md" >}}) pour vous aider à créer ce type de pages. + +## Configuration des Front Matter + +Chaque page Hugo doit définir un [Front Matter](https://gohugo.io/content/front-matter/) dans le format *yaml*, *toml* ou *json*. + +**Hugo-theme-learn** utilise les paramètres suivant en plus de ceux définis par Hugo: + +```toml ++++ +# Le Sommaire (table of content = toc) est activé par défaut. Modifier ce paramètre à true pour le désactiver. +# Note: Le sommaire est toujours désactivé pour les chapitres +disableToc = "false" +# Le titre de la page dans le menu sera préfixé par ce contentu HTML +pre = "" +# Le titre de la page dans le menu sera suffixé par ce contentu HTML +post = "" +# Modifier le type de la page pour changer l'affichage +chapter = false +# Cache la page du menu +hidden = false +# Nom de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page. +LastModifierDisplayName = "" +# Email de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page. +LastModifierEmail = "" ++++ +``` + +### Ajouter une icône à une entrée du menu + +Dans le Front Matter, ajouter un paramètre `pre` pour insérer du code HTML qui s'affichera avant le label du menu. L'exemple ci-dessous utilise l'icône de Github. + +```toml ++++ +title = "Repo Github" +pre = " " ++++ +``` + +![Titre avec icône](/en/cont/pages/images/frontmatter-icon.png) + +### Ordonner les entrées dans le menu + +Hugo permet de modifier facilement [l'ordre des menu](https://gohugo.io/content/ordering/). + +La manière la plus simple est de configurer le paramètre `weight` avec un nombre. + +```toml ++++ +title = "Ma page" +weight = 5 ++++ +``` + +## Page d'accueil + +Pour configurer votre page d'accueil, vous avez trois choix: + +1. Créer une page `_index.md` dans le dossier `content` et remplissez le fichier avec du *contenu Markdown* +2. Créer une page `index.html` dans le dossier `static` et remplissez le fichier avec du *contenu HTML* +3. Configurez votre serveur pour automatiquement rediriger la page d'accueil vers l'une de vos pages. diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/frontmatter-icon.png b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/frontmatter-icon.png new file mode 100644 index 000000000..a8dd653ab Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/frontmatter-icon.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-chapter.png b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-chapter.png new file mode 100644 index 000000000..593d7e229 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-chapter.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-default.png b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-default.png new file mode 100644 index 000000000..396e788ec Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/pages/images/pages-default.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/syntaxhighlight.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/syntaxhighlight.en.md new file mode 100644 index 000000000..ed1fe72c3 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/syntaxhighlight.en.md @@ -0,0 +1,89 @@ +--- +date: 2020-06-01T13:31:12+01:00 +title: Code highlighting +weight: 16 +--- + +Learn theme uses [highlight.js](https://highlightjs.org/) to provide code syntax highlighting. + +## Markdown syntax + +Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided. + + +```plaintext + ```json + [ + { + "title": "apples", + "count": [12000, 20000], + "description": {"text": "...", "sensitive": false} + }, + { + "title": "oranges", + "count": [17500, null], + "description": {"text": "...", "sensitive": false} + } + ] + ``` +``` + + +Renders to: + +```json +[ + { + "title": "apples", + "count": [12000, 20000], + "description": {"text": "...", "sensitive": false} + }, + { + "title": "oranges", + "count": [17500, null], + "description": {"text": "...", "sensitive": false} + } +] +``` + +## Supported languages + +Learn theme ships with its own version of highlight.js to support offline browsing. The included package supports 38 common languages, as described on the [highlight.js download page](https://highlightjs.org/download/). + +## Identifying failed language detection + +Highlight will write a warning to the browser console if a requested language was not found. For example, the following code block references an imaginary language `foo`. An error will be output to the console on this page. + +```plaintext + ```foo + bar + ``` +``` + +```nohighlight +Could not find the language 'foo', did you forget to load/include a language module?(anonymous) @ highlight.pack.js +``` + +## Supporting additional languages + +To support languages other than the 38 common languages included in the default highlight.js you will need to download your own version of highlight.js and add it to your site content. + +### Download custom highlight.js + +Visit [https://highlightjs.org/download/](https://highlightjs.org/download/) and select your desired language support. Note that more languages means greater package size. + +### Add custom highlight.js to static resources + +Inside the zip archive downloaded from highlight.js extract the file named `highlight.pack.js`. Move this file to the **new** location + +```nohighlight +static/js/highlight.pack.js +``` + +**Do not** replace the existing file at `themes/hugo-theme-learn/static/js/highlight.pack.js`. + +Including the file in the correct path will override the theme default highlight.pack.js and prevent issues caused in the future if the theme default file is updated. + +## Further usage information + +See [https://highlightjs.org/usage/](https://highlightjs.org/usage/) diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.en.md new file mode 100644 index 000000000..02972bb6b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.en.md @@ -0,0 +1,39 @@ +--- +date: 2018-11-29T08:41:44+01:00 +title: Tags +weight: 40 +tags: ["documentation", "tutorial"] +--- + +*Learn theme* support one default taxonomy of gohugo: the *tag* feature. + +## Configuration + +Just add tags to any page: + +```markdown +--- +date: 2018-11-29T08:41:44+01:00 +title: Theme tutorial +weight: 15 +tags: ["tutorial", "theme"] +--- +``` + +## Behavior + + +The tags are displayed at the top of the page, in their insertion order. + +Each tag is a link to a *Taxonomy* page displaying all the articles with the given tag. + +## List all the tags + +In the `config.toml` file you can add a shortcut to display all the tags + +```toml +[[menu.shortcuts]] +name = " Tags" +url = "/tags" +weight = 30 +``` \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.fr.md new file mode 100644 index 000000000..d19b396c6 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/cont/tags.fr.md @@ -0,0 +1,40 @@ +--- +date: 2018-11-29T08:41:44+01:00 +title: Tags +weight: 40 +tags: ["documentation", "tutorial"] +--- + + +Le *thème Learn* supporte une des taxonomy par défaut de GoHugo : les tags. + +## Configuration + +Il suffit d'ajouter un tableau de tags sur la page : + +```markdown +--- +date: 2018-11-29T08:41:44+01:00 +title: Tutoriel pour le thème +weight: 15 +tags: ["tutoriel", "theme"] +--- +``` + +## Comportement + +Les tags sont affichés en haut de la page, dans l'ordre dans lequel ils ont été saisis. + +Chaque tag est un lien vers une page *Taxonomy*, qui affiche tous les article avec ce tag. + + +## Liste des tags + +Il est possible de rajouter un raccourci dans le fichier `config.toml` afin d'afficher une page listant tous les tags + +```toml +[[menu.shortcuts]] +name = " Tags" +url = "/tags" +weight = 30 +``` \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/credits.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/credits.en.md new file mode 100644 index 000000000..1a489fcfc --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/credits.en.md @@ -0,0 +1,28 @@ +--- +title: Credits +disableToc: true +--- + +## Contributors + +Thanks to them for making Open Source Software a better place ! + +{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}} + +And a special thanks to [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), a fork of hugo-theme-learn. v2.0.0 of this theme is inspired by his work. + +## Packages and libraries +* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown +* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework +* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library +* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services... +* [horsey](https://bevacqua.github.io/horsey/) - Progressive and customizable autocomplete component +* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard +* [highlight.js](https://highlightjs.org) - Javascript syntax highlighter +* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support + +## Tooling + +* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation +* [Hugo](https://gohugo.io/) + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/credits.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/credits.fr.md new file mode 100644 index 000000000..536f09381 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/credits.fr.md @@ -0,0 +1,28 @@ +--- +title: Crédits +disableToc: true +--- + +## Contributeurs + +Merci à eux de rendre le monde Open Source meilleur ! + +{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}} + +Et un grand merci à [@vjeantet](https://github.com/vjeantet) pour son travail sur [docdock](https://github.com/vjeantet/hugo-theme-docdock), un fork de _hugo-theme-learn_. La v2.0.0 du thème est en grande partie inspirée de son travail. + +## Packages et librairies +* [mermaid](https://knsv.github.io/mermaid) - géneration de diagrames et graphiques à partir de texte similaire à Markdown +* [font awesome](http://fontawesome.io/) - Le framework de polices iconiques +* [jQuery](https://jquery.com) - La plus connue des librairies Javascript +* [lunr](https://lunrjs.com) - Lunr fournit des fonctions de recherche sans service externe +* [horsey](https://bevacqua.github.io/horsey/) - Autocomplétion de composants (utiliser pour les suggestions de recherche) +* [clipboard.js](https://zenorocha.github.io/clipboard.js) - Copier le texte dans le presse-papier +* [highlight.js](https://highlightjs.org) - Mise en valeur de syntaxes +* [modernizr](https://modernizr.com) - Une boite à outil Javascript qui permet aux développeurs d'utiliser les dernières fonctionnalités de CSS et HTML5, même sur de vieux navigateurs. + +## Outils + +* [Netlify](https://www.netlify.com) - Déploiement continue et hébergement de cette documentation +* [Hugo](https://gohugo.io/) + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.en.md new file mode 100644 index 000000000..754bb0f0c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.en.md @@ -0,0 +1,16 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Shortcodes +pre: "3. " +weight: 15 +--- + +Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities. + +But this happens to be a bad idea. Everyone uses Markdown because it's pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible. + +To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/). A shortcode is a simple snippet inside a page. + +**Hugo-theme-learn** provides multiple shortcodes on top of existing ones. + +{{%children style="h2" description="true" %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.fr.md new file mode 100644 index 000000000..b084d9bfd --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/_index.fr.md @@ -0,0 +1,16 @@ +--- +date: 2016-04-09T16:50:16+02:00 +title: Shortcodes +pre: "3. " +weight: 15 +--- + +Hugo utilise Markdown pour son format simple. Cependant, il y a beaucoup de chose que Markdown ne supporte pas bien. On pourrait utiliser du HTML pur pour améliorer les capacité du Markdown. + +Mais c'est probablement une mauvaise idée. Tout le monde utilise le Markdown parce que c'est pur et simple à lire même lorsqu'il est affiché en texte brut. Vous devez éviter le HTML autant que possible pour garder le contenu simple. + +Cependant, pour éviter les limitations, Hugo a créé les [shortcodes](https://gohugo.io/extras/shortcodes/). Un shortcode est un bout de code (*snippet*) dans une page. + +**Hugo-theme-learn** fournit de multiple shortcodes en plus de ceux existant. + +{{%children style="h2" description="true" %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 new file mode 100644 index 000000000..94e3d0e53 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf new file mode 100644 index 000000000..97377e99b Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf new file mode 100644 index 000000000..e589c73e9 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png new file mode 100644 index 000000000..48acf346c Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 new file mode 100644 index 000000000..9f1fe5645 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.md new file mode 100644 index 000000000..8a2429cf3 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.en.md @@ -0,0 +1,85 @@ +--- +title: Attachments +description : "The Attachments shortcode displays a list of files attached to a page." +--- + +The Attachments shortcode displays a list of files attached to a page. + +{{% attachments /%}} + +## Usage + +The shortcurt lists files found in a **specific folder**. +Currently, it support two implementations for pages + +1. If your page is a markdown file, attachements must be placed in a **folder** named like your page and ending with **.files**. + + > * content + > * _index.md + > * page.files + > * attachment.pdf + > * page.md + +2. If your page is a **folder**, attachements must be placed in a nested **'files'** folder. + + > * content + > * _index.md + > * page + > * index.md + > * files + > * attachment.pdf + +Be aware that if you use a multilingual website, you will need to have as many folders as languages. + +That's all! + +### Parameters + +| Parameter | Default | Description | +|:--|:--|:--| +| title | "Attachments" | List's title | +| style | "" | Choose between "orange", "grey", "blue" and "green" for nice style | +| pattern | ".*" | A regular expressions, used to filter the attachments by file name.

The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression). + +For example: + +* To match a file suffix of 'jpg', use **.*jpg** (not *.jpg). +* To match file names ending in 'jpg' or 'png', use **.*(jpg|png)** + +### Examples + +#### List of attachments ending in pdf or mp4 + + + {{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}} + +renders as + +{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}} + +#### Colored styled box + + {{%/*attachments style="orange" /*/%}} + +renders as + +{{% attachments style="orange" /%}} + + + {{%/*attachments style="grey" /*/%}} + +renders as + +{{% attachments style="grey" /%}} + + {{%/*attachments style="blue" /*/%}} + +renders as + +{{% attachments style="blue" /%}} + + {{%/*attachments style="green" /*/%}} + +renders as + +{{% attachments style="green" /%}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 new file mode 100644 index 000000000..94e3d0e53 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf new file mode 100644 index 000000000..97377e99b Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf new file mode 100644 index 000000000..e589c73e9 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png new file mode 100644 index 000000000..48acf346c Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 new file mode 100644 index 000000000..9f1fe5645 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.md new file mode 100644 index 000000000..c24093915 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/attachments.fr.md @@ -0,0 +1,85 @@ +--- +title: Attachments (Pièces jointes) +description : "The Attachments shortcode displays a list of files attached to a page." +--- + +Le shortcode *Attachments* affiche une liste de pièces jointes d'une page. + +{{% attachments /%}} + +## Utilisation + +Le shortcode affiche la liste de fichiers trouvés dans un **dossier spécifique** +A l'heure actuelle, il supporte deux implémentations + +1. Si votre page est un fichier Markdown, les pièces jointes doivent être placée dans un **dossier** nommé comme le nom de la page et suffixé par **.files**. + + > * content + > * _index.md + > * page.files + > * attachment.pdf + > * page.md + +2. Si votre page est un **dossier**, les pièces jointes doivent être placées dans un dossier fils **'files'**. + + > * content + > * _index.md + > * page + > * index.md + > * files + > * attachment.pdf + +Attention, si votre site est multi-langue, vous devrez avec autant de dossier qu'il y a de langues. + +C'est tout ! + +### Paramètres + +| Paramètre | Défaut | Description | +|:--|:--|:--| +| title | "Pièces jointes" | Titre de la liste | +| style | "" | Choisir entre "orange", "grey", "blue" et "green" pour un style plus sympa | +| pattern | ".*" | Une expression régulière, utilisée pour filtrer les pièces jointes par leur nom de fichier.

Le paramètre **pattern** doit être une [expression régulière](https://en.wikipedia.org/wiki/Regular_expression). + +Par exemple: + +* Pour trouver les fichiers avec le suffixe 'jpg', utilisez **.*jpg** (pas *.jpg). +* Pour trouver les fichiers avec les suffixe 'jpg' ou 'png', utilisez **.*(jpg|png)** + +### Exemples + +#### Lister les pièces jointes de type pdf ou mp4 + + + {{%/*attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/*/%}} + +s'affiche comme + +{{%attachments title="Fichiers associés" pattern=".*(pdf|mp4)"/%}} + +#### Modifier le style + + {{%/*attachments style="orange" /*/%}} + +s'affiche comme + +{{% attachments style="orange" /%}} + + + {{%/*attachments style="grey" /*/%}} + +s'affiche comme + +{{% attachments style="grey" /%}} + + {{%/*attachments style="blue" /*/%}} + +s'affiche comme + +{{% attachments style="blue" /%}} + + {{%/*attachments style="green" /*/%}} + +s'affiche comme + +{{% attachments style="green" /%}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.en.md new file mode 100644 index 000000000..9fb92bd98 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.en.md @@ -0,0 +1,16 @@ +--- +title: Button +description : "Nice buttons on your page." +--- + +A button is a just a clickable button with optional icon. + +``` +{{%/* button href="https://getgrav.org/" */%}}Get Grav{{%/* /button */%}} +{{%/* button href="https://getgrav.org/" icon="fas fa-download" */%}}Get Grav with icon{{%/* /button */%}} +{{%/* button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" */%}}Get Grav with icon right{{%/* /button */%}} +``` + +{{% button href="https://getgrav.org/" %}}Get Grav{{% /button %}} +{{% button href="https://getgrav.org/" icon="fas fa-download" %}}Get Grav with icon{{% /button %}} +{{% button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" %}}Get Grav with icon right{{% /button %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.fr.md new file mode 100644 index 000000000..66e55af75 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/button.fr.md @@ -0,0 +1,16 @@ +--- +title: Button (Bouton) +description : "De beaux boutons sur votre page." +--- + +Le shortcode *button* est simplement un bouton cliquable avec une icône optionnelle. + +``` +{{%/* button href="https://getgrav.org/" */%}}Téléchargez Grav{{%/* /button */%}} +{{%/* button href="https://getgrav.org/" icon="fas fa-download" */%}}Téléchargez Grav avec icône{{%/* /button */%}} +{{%/* button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" */%}}Téléchargez Grav avec icône à droite{{%/* /button */%}} +``` + +{{% button href="https://getgrav.org/" %}}Téléchargez Grav{{% /button %}} +{{% button href="https://getgrav.org/" icon="fas fa-download" %}}Téléchargez Grav avec icône{{% /button %}} +{{% button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" %}}Téléchargez Grav avec icône à droite{{% /button %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.en.md new file mode 100644 index 000000000..17bdcfb1d --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.en.md @@ -0,0 +1,45 @@ +--- +title : Children +description : List the child pages of a page +--- + +Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages. + +## Usage + +| Parameter | Default | Description | +|:--|:--|:--| +| page | _current_ | Specify the page name (section name) to display children for | +| style | "li" | Choose the style used to display descendants. It could be any HTML tag name | +| showhidden | "false" | When true, child pages hidden from the menu will be displayed | +| description | "false" | Allows you to include a short text under each page in the list. When no description exists for the page, children shortcode takes the first 70 words of your content. [Read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/) | +| depth | 1 | Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. **Tips:** set 999 to get all descendants | +| sort | none | Sort children by **Weight** - to sort on menu order, **Name** - to sort alphabetically on menu label, **Identifier** - to sort alphabetically on identifier set in frontmatter, and **URL** - to sort by URL | + +## Demo + + {{%/* children */%}} + +{{% children %}} + + {{%/* children description="true" */%}} + +{{%children description="true" %}} + + {{%/* children depth="3" showhidden="true" */%}} + +{{% children depth="3" showhidden="true" %}} + + {{%/* children style="h2" depth="3" description="true" */%}} + +{{% children style="h2" depth="3" description="true" %}} + + {{%/* children style="div" depth="999" */%}} + +{{% children style="div" depth="999" %}} + + + + + + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.fr.md new file mode 100644 index 000000000..672c5ad61 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/_index.fr.md @@ -0,0 +1,45 @@ +--- +title : Children (Pages filles) +description : Liste les pages filles de la page +--- + +Utilisez le shortcode *children* pour lister les pages filles de la page et tous ses déscendants (pages filles de pages filles). Par défaut, le shortcode affiche des liens vers les pages filles. + +## Utilisation + +| Paramètre | Défaut | Description | +|:--|:--|:--| +| page | _current_ | Spécifie le nom de la page (nom de la section) à afficher | +| style | "li" | Choisi le style à utiliser pour afficher les descendants. Cela peut être n'importe quel balise HTML | +| showhidden | "false" | Quand *true*, pages filles cachées dans le menu seront affichées quand même | +| description | "false" | Permet d'inclure le texte de la description de la page sous chaque entré de la liste.
quand aucune description existe pour la page, le shortcode prend les 70 premiers mots du contenu. [plus d'infos sur gohugo.io](https://gohugo.io/content/summaries/) | +| depth | 1 | Nombre de descendants à afficher. Par exemple, si la valeur est 2, le shortcode va afficher 2 niveaux de pages filels.
**Astuce:** Utilisez 999 pour avoir tous les descendants| +| sort | | Tri les pages filles par
  • Weight - Poids
  • Name - Nom
  • Identifier - Trier alphabétiquement par identifiant configuré dans le front matter
  • URL - URL
    • | + +## Démo + + {{%/* children */%}} + +{{% children %}} + + {{%/* children description="true" */%}} + +{{%children description="true" %}} + + {{%/* children depth="3" showhidden="true" */%}} + +{{% children depth="3" showhidden="true" %}} + + {{%/* children style="h2" depth="3" description="true" */%}} + +{{% children style="h2" depth="3" description="true" %}} + + {{%/* children style="div" depth="999" */%}} + +{{% children style="div" depth="999" %}} + + + + + + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.en.md new file mode 100644 index 000000000..d0c5179db --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 1" +description = "This is a demo child page" ++++ + +This is a demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md new file mode 100644 index 000000000..7737f5034 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 1" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md new file mode 100644 index 000000000..a4982f96e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1" +description = "This is a demo child page" ++++ + +This is a demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md new file mode 100644 index 000000000..e39cb5828 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md new file mode 100644 index 000000000..5ce56f4da --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1" +description = "This is a demo child page" ++++ + +This is a demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md new file mode 100644 index 000000000..31d2cd118 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md new file mode 100644 index 000000000..d5d9ab277 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1-1" +description = "This is a demo child page" ++++ + +This is a demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.fr.md new file mode 100644 index 000000000..3b0f7f096 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1-1" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md new file mode 100644 index 000000000..883b5b218 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1-1-1" +description = "This is a demo child page" ++++ + +This is a demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.fr.md new file mode 100644 index 000000000..5a1961725 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 1-1-1-1-1" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.en.md new file mode 100644 index 000000000..a96140c25 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.en.md @@ -0,0 +1,11 @@ ++++ +title = "page 2" +description = "" ++++ + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, + quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse + cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non + proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md new file mode 100644 index 000000000..a96140c25 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md @@ -0,0 +1,11 @@ ++++ +title = "page 2" +description = "" ++++ + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, + quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse + cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non + proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.en.md new file mode 100644 index 000000000..f603d4c0c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.en.md @@ -0,0 +1,6 @@ ++++ +title = "page test 3" +description = "This is a page test" ++++ + +This is a test 3 demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md new file mode 100644 index 000000000..6d649e807 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page test 3" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo test 3 \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.en.md new file mode 100644 index 000000000..f36f8616e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.en.md @@ -0,0 +1,6 @@ ++++ +title = "page 3" +description = "This is a demo child page" ++++ + +This is a demo child page, not displayed in the menu \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md new file mode 100644 index 000000000..1501cc82b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page 3" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.en.md new file mode 100644 index 000000000..b9f042d81 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.en.md @@ -0,0 +1,7 @@ ++++ +title = "page 4" +description = "This is a demo child page" +hidden = true ++++ + +This is a demo child page, not displayed in the menu \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md new file mode 100644 index 000000000..6735e5041 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md @@ -0,0 +1,7 @@ ++++ +title = "page 4" +description = "Ceci est une page test" +hidden = true ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.en.md new file mode 100644 index 000000000..045f0a1e2 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.en.md @@ -0,0 +1,6 @@ ++++ +title = "page test" +description = "This is a page test" ++++ + +This is a test demo child page \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.fr.md new file mode 100644 index 000000000..dd6cc3c3e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/children/test.fr.md @@ -0,0 +1,6 @@ ++++ +title = "page test" +description = "Ceci est une page test" ++++ + +Ceci est une page de demo \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.en.md new file mode 100644 index 000000000..dff19061c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.en.md @@ -0,0 +1,45 @@ +--- +title : Expand +description : "Displays an expandable/collapsible section of text on your page" +--- + +The Expand shortcode displays an expandable/collapsible section of text on your page. +Here is an example + +{{%expand%}} +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, +quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse +cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +{{%/expand%}} + + +## Usage + + +this shortcode takes exactly one optional parameter to define the text that appears next to the expand/collapse icon. (default is "Expand me...") + + {{%/*expand "Is this learn theme rocks ?" */%}}Yes !.{{%/* /expand*/%}} + +{{%expand "Is this learn theme rocks ?" %}}Yes !{{% /expand%}} + +# Demo + + {{%/*expand*/%}} + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, + quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse + cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non + proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + {{%/* /expand*/%}} + + +{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, +quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse +cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{% /expand%}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.fr.md new file mode 100644 index 000000000..efb86a3c9 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/expand.fr.md @@ -0,0 +1,45 @@ +--- +title : Expand +description : "Affiche une section de texte qui se plie et se déplie" +--- + +Le shortcode *Expand* affiche une section de texte qui se plie et se déplie. +Ci-dessous un exemple. + +{{%expand%}} +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, +quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse +cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +{{%/expand%}} + + +## Utilisation + + +Ce shortcode prends exactement un paramètre optionel pour définir le texte à côté de l'icone. (valeur par défaut est "Déroulez-moi...") + + {{%/*expand "Est-ce que ce thème envoie du pâté ?" */%}}Oui !.{{%/* /expand*/%}} + +{{%expand "Est-ce que ce thème envoie du pâté ?" %}}Oui !{{% /expand%}} + +# Demo + + {{%/*expand*/%}} + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, + quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse + cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non + proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + {{%/* /expand*/%}} + + +{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, +quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse +cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{% /expand%}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.en.md new file mode 100644 index 000000000..b5ed111dd --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.en.md @@ -0,0 +1,210 @@ +--- +title : "Mermaid" +description : "Generation of diagram and flowchart from text in a similar manner as markdown" +--- + +[Mermaid](https://mermaidjs.github.io/) is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown. + +Just insert your mermaid code in the `mermaid` shortcode and that's it. + +## Flowchart example + + {{}} + graph LR; + A[Hard edge] -->|Link text| B(Round edge) + B --> C{Decision} + C -->|One| D[Result one] + C -->|Two| E[Result two] + {{}} + +renders as + +{{}} +graph LR; + A[Hard edge] -->|Link text| B(Round edge) + B --> C{Decision} + C -->|One| D[Result one] + C -->|Two| E[Result two] +{{}} + +## Sequence example + + {{}} + sequenceDiagram + participant Alice + participant Bob + Alice->>John: Hello John, how are you? + loop Healthcheck + John->John: Fight against hypochondria + end + Note right of John: Rational thoughts
    prevail... + John-->Alice: Great! + John->Bob: How about you? + Bob-->John: Jolly good! + {{}} + +renders as + +{{}} +sequenceDiagram + participant Alice + participant Bob + Alice->>John: Hello John, how are you? + loop Healthcheck + John->John: Fight against hypochondria + end + Note right of John: Rational thoughts
    prevail... + John-->Alice: Great! + John->Bob: How about you? + Bob-->John: Jolly good! +{{    }} + +## GANTT Example + + {{}} + gantt + dateFormat YYYY-MM-DD + title Adding GANTT diagram functionality to mermaid + section A section + Completed task :done, des1, 2014-01-06,2014-01-08 + Active task :active, des2, 2014-01-09, 3d + Future task : des3, after des2, 5d + Future task2 : des4, after des3, 5d + section Critical tasks + Completed task in the critical line :crit, done, 2014-01-06,24h + Implement parser and jison :crit, done, after des1, 2d + Create tests for parser :crit, active, 3d + Future task in critical line :crit, 5d + Create tests for renderer :2d + Add to mermaid :1d + {{}} + + +renders as + +{{}} +gantt + dateFormat YYYY-MM-DD + title Adding GANTT diagram functionality to mermaid + section A section + Completed task :done, des1, 2014-01-06,2014-01-08 + Active task :active, des2, 2014-01-09, 3d + Future task : des3, after des2, 5d + Future task2 : des4, after des3, 5d + section Critical tasks + Completed task in the critical line :crit, done, 2014-01-06,24h + Implement parser and jison :crit, done, after des1, 2d + Create tests for parser :crit, active, 3d + Future task in critical line :crit, 5d + Create tests for renderer :2d + Add to mermaid :1d +{{}} + + +### Class example + + {{}} + classDiagram + Class01 <|-- AveryLongClass : Cool + Class03 *-- Class04 + Class05 o-- Class06 + Class07 .. Class08 + Class09 --> C2 : Where am i? + Class09 --* C3 + Class09 --|> Class07 + Class07 : equals() + Class07 : Object[] elementData + Class01 : size() + Class01 : int chimp + Class01 : int gorilla + Class08 <--> C2: Cool label + {{}} + +renders as + + +{{}} +classDiagram + Class01 <|-- AveryLongClass : Cool + Class03 *-- Class04 + Class05 o-- Class06 + Class07 .. Class08 + Class09 --> C2 : Where am i? + Class09 --* C3 + Class09 --|> Class07 + Class07 : equals() + Class07 : Object[] elementData + Class01 : size() + Class01 : int chimp + Class01 : int gorilla + Class08 <--> C2: Cool label +{{}} + + +### Git example + + {{}} + gitGraph: + options + { + "nodeSpacing": 150, + "nodeRadius": 10 + } + end + commit + branch newbranch + checkout newbranch + commit + commit + checkout master + commit + commit + merge newbranch + {{}} + +renders as + +{{}} +gitGraph: +options +{ + "nodeSpacing": 150, + "nodeRadius": 10 +} +end + commit + branch newbranch + checkout newbranch + commit + commit + checkout master + commit + commit + merge newbranch +{{}} + +### State Diagrams + + {{}} + stateDiagram-v2 + open: Open Door + closed: Closed Door + locked: Locked Door + open --> closed: Close + closed --> locked: Lock + locked --> closed: Unlock + closed --> open: Open + {{}} + +renders as + +{{}} +stateDiagram-v2 + open: Open Door + closed: Closed Door + locked: Locked Door + open --> closed: Close + closed --> locked: Lock + locked --> closed: Unlock + closed --> open: Open +{{}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.fr.md new file mode 100644 index 000000000..7798785dd --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/mermaid.fr.md @@ -0,0 +1,205 @@ +--- +title : "Mermaid" +description : "Génération de diagrammes à partir de texte, dans le même style que Markdown" +--- + +[Mermaid](https://mermaidjs.github.io/) est une bibliothèque Javascript qui permet de générer des diagrammes (séquence, état, gantt, etc.) à partir de texte, dans le même style que Markdown. + +Insérer votre code Mermaid dans un shortcode `mermaid` et c'est tout. + +## Flowchart example + {{}} + graph LR; + A[Bords droits] -->|Lien texte| B(Bords arondis) + B --> C{Décision} + C -->|Un| D[Résultat un] + C -->|Deux| E[Résultat deux] + {{}} + +renders as + +{{}} +graph LR; + A[Bords droits] -->|Lien texte| B(Bords arondis) + B --> C{Décision} + C -->|Un| D[Résultat un] + C -->|Deux| E[Résultat deux] +{{< /mermaid >}} + +## Sequence example + + {{}} + sequenceDiagram + participant Alice + participant Bob + Alice->>John: Salut John, comment vas-tu? + loop Vérification + John->John: Se bat contre l'hyponcodrie. + end + Note right of John: Les pensées rationnelles
    prédominent... + John-->Alice: Super! + John->Bob: Et toi? + Bob-->John: Au top! + {{}} + +renders as + +{{}} +sequenceDiagram + participant Alice + participant Bob + Alice->>John: Salut John, comment vas-tu? + loop Vérification + John->John: Se bat contre l'hyponcodrie. + end + Note right of John: Les pensées rationnelles
    prédominent... + John-->Alice: Super! + John->Bob: Et toi? + Bob-->John: Au top! +{{< /mermaid >}} + +## GANTT Example + + {{}} + gantt + dateFormat YYYY-MM-DD + title Ajout de la fonctionnalité de GANTT à Mermaid + section Une section + Tâche complétée :done, des1, 2014-01-06,2014-01-08 + Tâche en cours :active, des2, 2014-01-09, 3d + Future tâche : des3, after des2, 5d + Future tâche 2 : des4, after des3, 5d + section Tâches critiques + Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h + Implémenter le parser et jison :crit, done, after des1, 2d + Créer des tests pour le parser :crit, active, 3d + Future tâche dans le chemin critique :crit, 5d + Créer des tests pour le renderer :2d + Ajout à Mermaid :1d + {{}} + +renders as + +{{}} +gantt + dateFormat YYYY-MM-DD + title Ajout de la fonctionnalité de GANTT à Mermaid + section Une section + Tâche complétée :done, des1, 2014-01-06,2014-01-08 + Tâche en cours :active, des2, 2014-01-09, 3d + Future tâche : des3, after des2, 5d + Future tâche 2 : des4, after des3, 5d + section Tâches critiques + Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h + Implémenter le parser et jison :crit, done, after des1, 2d + Créer des tests pour le parser :crit, active, 3d + Future tâche dans le chemin critique :crit, 5d + Créer des tests pour le renderer :2d + Ajout à Mermaid :1d +{{}} + +### Class example + + {{/* mermaid */}} + classDiagram + Class01 <|-- AveryLongClass : Cool + Class03 *-- Class04 + Class05 o-- Class06 + Class07 .. Class08 + Class09 --> C2 : Where am i? + Class09 --* C3 + Class09 --|> Class07 + Class07 : equals() + Class07 : Object[] elementData + Class01 : size() + Class01 : int chimp + Class01 : int gorilla + Class08 <--> C2: Cool label + {{/* /mermaid */}} + +renders as + +{{< mermaid >}} +classDiagram + Class01 <|-- AveryLongClass : Cool + Class03 *-- Class04 + Class05 o-- Class06 + Class07 .. Class08 + Class09 --> C2 : Where am i? + Class09 --* C3 + Class09 --|> Class07 + Class07 : equals() + Class07 : Object[] elementData + Class01 : size() + Class01 : int chimp + Class01 : int gorilla + Class08 <--> C2: Cool label +{{< /mermaid >}} + +### Git example + + {{}} + gitGraph: + options + { + "nodeSpacing": 150, + "nodeRadius": 10 + } + end + commit + branch newbranch + checkout newbranch + commit + commit + checkout master + commit + commit + merge newbranch + {{}} + +renders as + +{{< mermaid >}} +gitGraph: +options +{ + "nodeSpacing": 150, + "nodeRadius": 10 +} +end + commit + branch newbranch + checkout newbranch + commit + commit + checkout master + commit + commit + merge newbranch +{{< /mermaid >}} + +### State Diagrams + + {{}} + stateDiagram-v2 + ouvert: Ouvert + clos: Clos + fermé: Fermé + ouvert --> clos + clos --> fermé: Lock + fermé --> clos: Unlock + clos --> ouvert: Open + {{}} + +renders as + +{{}} +stateDiagram-v2 + ouvert: Ouvert + clos: Clos + fermé: Fermé + ouvert --> clos + clos --> fermé: Lock + fermé --> clos: Unlock + clos --> ouvert: Open +{{}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.en.md new file mode 100644 index 000000000..c82a6e9f5 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.en.md @@ -0,0 +1,62 @@ +--- +title: Notice +description : "Disclaimers to help you structure your page" +--- + +The notice shortcode shows 4 types of disclaimers to help you structure your page. + +### Note + +``` +{{%/* notice note */%}} +A notice disclaimer +{{%/* /notice */%}} +``` + +renders as + +{{% notice note %}} +A notice disclaimer +{{% /notice %}} + +### Info + +``` +{{%/* notice info */%}} +An information disclaimer +{{%/* /notice */%}} +``` + +renders as + +{{% notice info %}} +An information disclaimer +{{% /notice %}} + +### Tip + +``` +{{%/* notice tip */%}} +A tip disclaimer +{{%/* /notice */%}} +``` + +renders as + +{{% notice tip %}} +A tip disclaimer +{{% /notice %}} + +### Warning + +``` +{{%/* notice warning */%}} +A warning disclaimer +{{%/* /notice */%}} +``` + +renders as + +{{% notice warning %}} +A warning disclaimer +{{% /notice %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.fr.md new file mode 100644 index 000000000..91e4d7052 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/notice.fr.md @@ -0,0 +1,62 @@ +--- +title: Notice +description : "Message pour vous aider à structurer votre contenu" +--- + +Le shortcode *Notice* permet d'afficher 4 types de message pour vous aider à structurer votre contenu. + +### Note + +``` +{{%/* notice note */%}} +Une notice de type *note* +{{%/* /notice */%}} +``` + +s'affiche comme + +{{% notice note %}} +Une notice de type *note* +{{% /notice %}} + +### Info + +``` +{{%/* notice info */%}} +Une notice de type *info* +{{%/* /notice */%}} +``` + +s'affiche comme + +{{% notice info %}} +Une notice de type *info* +{{% /notice %}} + +### Tip + +``` +{{%/* notice tip */%}} +Une notice de type *tip* +{{%/* /notice */%}} +``` + +s'affiche comme + +{{% notice tip %}} +Une notice de type *tip* +{{% /notice %}} + +### Warning + +``` +{{%/* notice warning */%}} +Une notice de type *warning* +{{%/* /notice */%}} +``` + +s'affiche comme + +{{% notice warning %}} +Une notice de type *warning* +{{% /notice %}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.en.md new file mode 100644 index 000000000..f431ffb90 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.en.md @@ -0,0 +1,23 @@ +--- +title: Site param +description : "Get value of site params variables in your page." +--- + +`siteparam` shortcode is used to help you print values of site params. + +For instance, in this current site, the `editURL` variable is used in `config.toml` + +```toml +[params] + editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/" +``` + +Use the `siteparam` shortcode to display its value. + +``` +`editURL` Value : {{%/* siteparam "editURL" */%}} +``` + +is displayed as + +`editURL` Value : {{% siteparam "editURL" %}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.fr.md new file mode 100644 index 000000000..508100b94 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/siteparam.fr.md @@ -0,0 +1,23 @@ +--- +title: Site param +description : "Afficher la valeur d'un paramètre global du site dans votre page" +--- + +Les shortcode `siteparam` est utilisé pour vous aider à afficher des valeurs provenant des paramètres globaux du site. + +Par exemple, dans ce site, le paramètre `editURL` est utilisé dans le fichier `config.toml` + +```toml +[params] + editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/" +``` + +Utilisez le shortcode `siteparam` pour affichier sa valeur. + +``` +Valeur de `editURL` : {{%/* siteparam "editURL" */%}} +``` + +s'affiche comme + +Valeur de `editURL` : {{% siteparam "editURL" %}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/tabs.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/tabs.en.md new file mode 100644 index 000000000..d664eeaca --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/shortcodes/tabs.en.md @@ -0,0 +1,119 @@ +--- +title: Tabbed views +description : "Synchronize selection of content in different tabbed views" +--- + +Choose which content to see across the page. Very handy for providing code +snippets for multiple languages or providing configuration in different formats. + +## Code example + + {{}} + {{%/* tab name="python" */%}} + ```python + print("Hello World!") + ``` + {{%/* /tab */%}} + {{%/* tab name="R" */%}} + ```R + > print("Hello World!") + ``` + {{%/* /tab */%}} + {{%/* tab name="Bash" */%}} + ```Bash + echo "Hello World!" + ``` + {{%/* /tab */%}} + {{}} + +Renders as: + +{{< tabs >}} +{{% tab name="python" %}} +```python +print("Hello World!") +``` +{{% /tab %}} +{{% tab name="R" %}} +```R +> print("Hello World!") +``` +{{% /tab %}} +{{% tab name="Bash" %}} +```Bash +echo "Hello World!" +``` +{{% /tab %}} +{{< /tabs >}} + +Tab views with the same tabs that belong to the same group sychronize their selection: + +{{< tabs >}} +{{% tab name="python" %}} +```python +print("Hello World!") +``` +{{% /tab %}} +{{% tab name="R" %}} +```R +> print("Hello World!") +``` +{{% /tab %}} +{{% tab name="Bash" %}} +```Bash +echo "Hello World!" +``` +{{% /tab %}} +{{< /tabs >}} + +## Config example + + {{}} + {{%/* tab name="json" */%}} + ```json + { + "Hello": "World" + } + ``` + {{%/* /tab */%}} + {{%/* tab name="XML" */%}} + ```xml + World + ``` + {{%/* /tab */%}} + {{%/* tab name="properties" */%}} + ```properties + Hello = World + ``` + {{%/* /tab */%}} + {{}} + +Renders as: + +{{< tabs groupId="config" >}} +{{% tab name="json" %}} +```json +{ + "Hello": "World" +} +``` +{{% /tab %}} +{{% tab name="XML" %}} +```xml +World +``` +{{% /tab %}} +{{% tab name="properties" %}} +```properties +Hello = World +``` +{{% /tab %}} +{{< /tabs >}} + +{{% notice warning %}} +When using tab views with different content sets, make sure to use a common `groupId` for equal sets but distinct +`groupId` for different sets. The `groupId` defaults to `'default'`. +**Take this into account across the whole site!** +The tab selection is restored automatically based on the `groupId` and if it cannot find a tab item because it came + from the `'default'` group on a different page then all tabs will be empty at first. +{{% /notice %}} diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.en.md b/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.en.md new file mode 100644 index 000000000..4d06d8b41 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.en.md @@ -0,0 +1,13 @@ +--- +title: Showcase +disableToc: true +--- + +#### [TAT](https://ovh.github.io/tat/overview/) by OVH +![TAT image](/images/showcase/tat.png?width=50pc) + +#### [Tshark.dev](https://tshark.dev) by Ross Jacobs +![Tshark.dev image](/images/showcase/tshark_dev.png?width=50pc) + +#### [inteliver](https://docs.inteliver.com) by Amir Lavasani +![docs.inteliver.com image](/images/showcase/inteliver_docs.png?width=50pc) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.fr.md b/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.fr.md new file mode 100644 index 000000000..fcb9d7f02 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/content/showcase.fr.md @@ -0,0 +1,14 @@ +--- +title: Vitrine +disableToc: true +slug: vitrine +--- + +#### [TAT](https://ovh.github.io/tat/overview/) par OVH +![TAT image](/images/showcase/tat.png?width=50pc) + +#### [Tshark.dev](https://tshark.dev) par Ross Jacobs +![Tshark.dev image](/images/showcase/tshark_dev.png?width=50pc) + +#### [inteliver](https://docs.inteliver.com) by Amir Lavasani +![docs.inteliver.com image](/images/showcase/inteliver_docs.png?width=50pc) \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/custom-footer.html b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/custom-footer.html new file mode 100644 index 000000000..50e11eb39 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/custom-footer.html @@ -0,0 +1,10 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/logo.html b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/logo.html new file mode 100644 index 000000000..e1ef57cab --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/logo.html @@ -0,0 +1,39 @@ + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/menu-footer.html b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/menu-footer.html new file mode 100644 index 000000000..5a35bd00f --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/layouts/partials/menu-footer.html @@ -0,0 +1,14 @@ +
    + + Download + + + Star + + + Fork + +

    Built with from Grav and Hugo

    +
    + + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/layouts/shortcodes/ghcontributors.html b/documentation/staging/1.2/themes/learn/exampleSite/layouts/shortcodes/ghcontributors.html new file mode 100644 index 000000000..3e8a92872 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/layouts/shortcodes/ghcontributors.html @@ -0,0 +1,31 @@ + +
    + {{ $url := .Get 0 }} + {{ range getJSON $url }} +
    + + + {{.contributions}} commits +
    + {{ end }} +
    \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/css/theme-mine.css b/documentation/staging/1.2/themes/learn/exampleSite/static/css/theme-mine.css new file mode 100644 index 000000000..2bbc86814 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/static/css/theme-mine.css @@ -0,0 +1,104 @@ + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#599a3e; /* Color of links */ + --MAIN-LINK-HOVER-color:#3f6d2c; /* Color of hovered links */ + --MAIN-ANCHOR-color: #599a3e; /* color of anchors on titles */ + + --MENU-HEADER-BG-color:#74b559; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#9cd484; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#599a3e; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #84c767; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #c7f7c4; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#1b211c; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#222723; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #599a3e; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #18211c; /* Color of
    separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} + diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.eot b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.eot new file mode 100644 index 000000000..702d2ccdb Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.eot differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.svg b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.svg new file mode 100644 index 000000000..811d3aa45 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.ttf b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.ttf new file mode 100644 index 000000000..4c4637b2a Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.ttf differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff new file mode 100644 index 000000000..d95d5ca0d Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff2 b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff2 new file mode 100644 index 000000000..39074b234 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/fonts/monogramos-webfont.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/inteliver_docs.png b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/inteliver_docs.png new file mode 100644 index 000000000..9d9bf3248 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/inteliver_docs.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tat.png b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tat.png new file mode 100644 index 000000000..35a5e6323 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tat.png differ diff --git a/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tshark_dev.png b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tshark_dev.png new file mode 100644 index 000000000..08f81f97f Binary files /dev/null and b/documentation/staging/1.2/themes/learn/exampleSite/static/images/showcase/tshark_dev.png differ diff --git a/documentation/staging/1.2/themes/learn/i18n/ar.toml b/documentation/staging/1.2/themes/learn/i18n/ar.toml new file mode 100644 index 000000000..cfce2ed6e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/ar.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "...البحث" + +[Clear-History] +other = "مسح السجل" + +[Attachments-label] +other = "مرفقات" + +[title-404] +other = "خطأ" + +[message-404] +other = ".¯\\_(ツ)_/¯أوبس. يبدو أن هذه الصفحة غير موجودة" + +[Go-to-homepage] +other = "الذهاب إلى الصفحة الرئيسية" + +[Edit-this-page] +other = "تعديل هذه الصفحة" + +[Shortcuts-Title] +other = "المزيد" + +[Expand-title] +other = "...قم بتوسيع" + +[BinaryPrefix-kilobyte] +other = "kb" \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/i18n/de.toml b/documentation/staging/1.2/themes/learn/i18n/de.toml new file mode 100644 index 000000000..2d50ed381 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/de.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Suchen..." + +[Clear-History] +other = "Verlauf löschen" + +[Attachments-label] +other = "Anhänge" + +[title-404] +other = "Fehler" + +[message-404] +other = "Huch. Diese Seite scheint nicht zu existieren ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Gehe zur Homepage" + +[Edit-this-page] +other = "Bearbeite diese Seite" + +[Shortcuts-Title] +other = "Mehr" + +[Expand-title] +other = "Erweitere mich..." + +[BinaryPrefix-kilobyte] +other = "kb" \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/i18n/en.toml b/documentation/staging/1.2/themes/learn/i18n/en.toml new file mode 100644 index 000000000..7b7d0caa6 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/en.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Search..." + +[Clear-History] +other = "Clear History" + +[Attachments-label] +other = "Attachments" + +[title-404] +other = "Error" + +[message-404] +other = "Woops. Looks like this page doesn't exist ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Go to homepage" + +[Edit-this-page] +other = "Edit this page" + +[Shortcuts-Title] +other = "More" + +[Expand-title] +other = "Expand me..." + +[BinaryPrefix-kilobyte] +other = "kb" \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/i18n/es.toml b/documentation/staging/1.2/themes/learn/i18n/es.toml new file mode 100644 index 000000000..aad5aa354 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/es.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Buscar..." + +[Clear-History] +other = "Borrar Historial" + +[Attachments-label] +other = "Adjuntos" + +[title-404] +other = "Error" + +[message-404] +other = "Ups. Parece que la página no existe ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Ir al inicio" + +[Edit-this-page] +other = "Editar esta página" + +[Shortcuts-Title] +other = "Más" + +[Expand-title] +other = "Expandir..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/fr.toml b/documentation/staging/1.2/themes/learn/i18n/fr.toml new file mode 100644 index 000000000..65bd26ec9 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/fr.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Rechercher..." + +[Clear-History] +other = "Supprimer l'historique" + +[Attachments-label] +other = "Pièces jointes" + +[title-404] +other = "Erreur" + +[message-404] +other = "Oups. On dirait que cette page n'existe pas ¯\\_(ツ)_/¯" + +[Go-to-homepage] +other = "Vers la page d'accueil" + +[Edit-this-page] +other = "Modifier la page" + +[Shortcuts-Title] +other = "Aller plus loin" + +[Expand-title] +other = "Déroulez-moi..." + +[BinaryPrefix-kilobyte] +other = "ko" \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/i18n/hi.toml b/documentation/staging/1.2/themes/learn/i18n/hi.toml new file mode 100644 index 000000000..8d19ca359 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/hi.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "खोजे..." + +[Clear-History] +other = "इतिहास मिटाएँ" + +[Attachments-label] +other = "संलग्नंक (अटैचमेंट)" + +[title-404] +other = "त्रुटि" + +[message-404] +other = "यह पृष्ठ अभि अनुपलब्ध है!" + +[Go-to-homepage] +other = "मुख्य पृष्ठ पर जाऐ" + +[Edit-this-page] +other = "यह पृष्ठ संपादित करें" + +[Shortcuts-Title] +other = "अधिक सामग्री दिखाएं" + +[Expand-title] +other = "विस्तार करे..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/id.toml b/documentation/staging/1.2/themes/learn/i18n/id.toml new file mode 100644 index 000000000..fac7e4500 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/id.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Telusuri..." + +[Clear-History] +other = "Bersihkan Riwayat" + +[Attachments-label] +other = "Lampiran" + +[title-404] +other = "Kesalahan" + +[message-404] +other = "Oops. Sepertinya halaman ini tidak ada ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Ke halaman depan" + +[Edit-this-page] +other = "Edit halaman ini" + +[Shortcuts-Title] +other = "Lainnya" + +[Expand-title] +other = "Bentangkan..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/ja.toml b/documentation/staging/1.2/themes/learn/i18n/ja.toml new file mode 100644 index 000000000..02769be7d --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/ja.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "検索..." + +[Clear-History] +other = "履歴削除" + +[Attachments-label] +other = "添付" + +[title-404] +other = "エラー" + +[message-404] +other = "おっと。ページが見当たりません。 ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "ホームページへ行く" + +[Edit-this-page] +other = "このページを編集" + +[Shortcuts-Title] +other = "更に" + +[Expand-title] +other = "開く..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/nl.toml b/documentation/staging/1.2/themes/learn/i18n/nl.toml new file mode 100644 index 000000000..b4d604bae --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/nl.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Zoeken..." + +[Clear-History] +other = "Wis geschiedenis" + +[Attachments-label] +other = "Bijlagen" + +[title-404] +other = "Error" + +[message-404] +other = "Blijkbaar bestaat deze pagina niet ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Naar startpagina" + +[Edit-this-page] +other = "Deze pagina bewerken" + +[Shortcuts-Title] +other = "Snelkoppelingen" + +[Expand-title] +other = "Lees meer..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/pt.toml b/documentation/staging/1.2/themes/learn/i18n/pt.toml new file mode 100644 index 000000000..6575b4ac2 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/pt.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Procurar..." + +[Clear-History] +other = "Limpar Histórico" + +[Attachments-label] +other = "Anexos" + +[title-404] +other = "Erro" + +[message-404] +other = "Ops. Parece que a página não existe ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Ir para o início" + +[Edit-this-page] +other = "Editar esta página" + +[Shortcuts-Title] +other = "Mais" + +[Expand-title] +other = "Expandir..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/ru.toml b/documentation/staging/1.2/themes/learn/i18n/ru.toml new file mode 100644 index 000000000..84b7df9b3 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/ru.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Поиск..." + +[Clear-History] +other = "Очистить историю" + +[Attachments-label] +other = "Присоединенные файлы" + +[title-404] +other = "Ошибка" + +[message-404] +other = "Упс. Выглядит будто такой страницы нет ¯\\_(ツ)_/¯." + +[Go-to-homepage] +other = "Перейти на главную" + +[Edit-this-page] +other = "Редактировать" + +[Shortcuts-Title] +other = "Еще" + +[Expand-title] +other = "Развернуть..." + +[BinaryPrefix-kilobyte] +other = "килобайт" \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/i18n/tr.toml b/documentation/staging/1.2/themes/learn/i18n/tr.toml new file mode 100644 index 000000000..c3affe3d2 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/tr.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "Ara..." + +[Clear-History] +other = "Geçmişi Temizle" + +[Attachments-label] +other = "Ekler" + +[title-404] +other = "Hata" + +[message-404] +other = "Uups. Görünüşe göre böyle bir sayfa yok ¯\\_(ツ)_/¯" + +[Go-to-homepage] +other = "Anasayfaya dön" + +[Edit-this-page] +other = "Sayfayı düzenle" + +[Shortcuts-Title] +other = "Dahası Var" + +[Expand-title] +other = "Genişlet..." + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/i18n/zh-cn.toml b/documentation/staging/1.2/themes/learn/i18n/zh-cn.toml new file mode 100644 index 000000000..4a6d43593 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/i18n/zh-cn.toml @@ -0,0 +1,29 @@ +[Search-placeholder] +other = "搜索..." + +[Clear-History] +other = "清理历史记录" + +[Attachments-label] +other = "附件" + +[title-404] +other = "错误" + +[message-404] +other = "哎哟。 看起来这个页面不存在 ¯\\_(ツ)_/¯。" + +[Go-to-homepage] +other = "转到主页" + +[Edit-this-page] +other = "编辑当前页" + +[Shortcuts-Title] +other = "更多" + +[Expand-title] +other = "展开" + +[BinaryPrefix-kilobyte] +other = "kb" diff --git a/documentation/staging/1.2/themes/learn/images/screenshot.png b/documentation/staging/1.2/themes/learn/images/screenshot.png new file mode 100644 index 000000000..85966a2c0 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/images/screenshot.png differ diff --git a/documentation/staging/1.2/themes/learn/images/tn.png b/documentation/staging/1.2/themes/learn/images/tn.png new file mode 100644 index 000000000..b1d64bdbc Binary files /dev/null and b/documentation/staging/1.2/themes/learn/images/tn.png differ diff --git a/documentation/staging/1.2/themes/learn/layouts/404.html b/documentation/staging/1.2/themes/learn/layouts/404.html new file mode 100644 index 000000000..a5bb8fce0 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/404.html @@ -0,0 +1,56 @@ + + + + + {{ partial "meta.html" . }} {{ partial "favicon.html" . }} {{ .Scratch.Add "title" "" }}{{ if eq .Site.Data.titles .Title }}{{ .Scratch.Set "title" (index .Site.Data.titles .Title).title }}{{ else }}{{ .Scratch.Set "title" .Title}}{{end}} + {{ .Scratch.Get "title" }} + + {{ $assetBusting := not .Site.Params.disableAssetsBusting }} + + + + + + + + {{with .Site.Params.themeVariant}} + + {{end}} + +{{ partial "custom-header.html" . }} + + + + +
    +
    +
    +
    +

    {{T "title-404"}}

    +

    +

    +

    {{T "message-404"}}

    +

    +

    {{T "Go-to-homepage"}}

    +

    Page not found!

    +
    +
    + +
    + + + diff --git a/documentation/staging/1.2/themes/learn/layouts/_default/list.html b/documentation/staging/1.2/themes/learn/layouts/_default/list.html new file mode 100644 index 000000000..d1ce3ec11 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/_default/list.html @@ -0,0 +1,22 @@ +{{ partial "header.html" . }} + +{{ if eq .Kind "section" }} + {{ .Content }} +{{end}} + +{{ if or (eq .Kind "taxonomy") (eq .Kind "term") }} + +{{end}} + +
    + {{with .Params.LastModifierDisplayName}} + {{ . }} {{with $.Date}} {{ .Format "02/01/2006" }}{{end}} + + {{end}} +
    + +{{ partial "footer.html" . }} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/_default/single.html b/documentation/staging/1.2/themes/learn/layouts/_default/single.html new file mode 100644 index 000000000..d3d9f2536 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/_default/single.html @@ -0,0 +1,12 @@ +{{ partial "header.html" . }} + +{{ .Content }} + +
    + {{with .Params.LastModifierDisplayName}} + {{ . }} {{with $.Date}} {{ .Format "02/01/2006" }}{{end}} + + {{end}} +
    + +{{ partial "footer.html" . }} diff --git a/documentation/staging/1.2/themes/learn/layouts/index.html b/documentation/staging/1.2/themes/learn/layouts/index.html new file mode 100644 index 000000000..cdf25d915 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/index.html @@ -0,0 +1,31 @@ +{{ partial "header.html" . }} + + navigation + + +{{if .Site.Home.Content }} +{{.Site.Home.Content}} +{{else}} + {{if eq .Site.Language.Lang "fr"}} +

    Personaliser la page d'accueil

    +

    + Le site fonctionne. Ne pas oublier de personaliser cette page avec votre propre contenu. 3 manières de faire : +

    +
      +
    • 1. Créer un fichier _index.md dans le dossier content et le remplir de Markdown
      • +
    • 2. Créer un fichier index.html dans le dossier static et le remplir de code HTML
      • +
    • 3. Configurer le serveur http pour rediriger automatiquement la homepage vers la page de votre choix dans le site
      • +
    + {{else}} +

    Customize your own home page

    +

    + The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices : +

    +
      +
    • 1. Create an _index.md document in content folder and fill it with Markdown content
      • +
    • 2. Create an index.html file in the static folder and fill the file with HTML content
      • +
    • 3. Configure your server to automatically redirect home page to one your documentation page
      • +
    + {{end}} +{{ end }} +{{ partial "footer.html" . }} diff --git a/documentation/staging/1.2/themes/learn/layouts/index.json b/documentation/staging/1.2/themes/learn/layouts/index.json new file mode 100644 index 000000000..367f3b318 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/index.json @@ -0,0 +1,12 @@ +[{{ range $index, $page := .Site.Pages }} +{{- if ne $page.Type "json" -}} +{{- if and $index (gt $index 0) -}},{{- end }} +{ + "uri": "{{ $page.Permalink }}", + "title": "{{ htmlEscape $page.Title}}", + "tags": [{{ range $tindex, $tag := $page.Params.tags }}{{ if $tindex }}, {{ end }}"{{ $tag| htmlEscape }}"{{ end }}], + "description": "{{ htmlEscape .Description}}", + "content": {{$page.Plain | jsonify}} +} +{{- end -}} +{{- end -}}] \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/custom-comments.html b/documentation/staging/1.2/themes/learn/layouts/partials/custom-comments.html new file mode 100644 index 000000000..6f5a034d1 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/custom-comments.html @@ -0,0 +1,3 @@ + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/custom-footer.html b/documentation/staging/1.2/themes/learn/layouts/partials/custom-footer.html new file mode 100644 index 000000000..9bb0f4850 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/custom-footer.html @@ -0,0 +1,5 @@ + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/custom-header.html b/documentation/staging/1.2/themes/learn/layouts/partials/custom-header.html new file mode 100644 index 000000000..294af2914 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/custom-header.html @@ -0,0 +1,5 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/favicon.html b/documentation/staging/1.2/themes/learn/layouts/partials/favicon.html new file mode 100644 index 000000000..1a45be0fc --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/favicon.html @@ -0,0 +1 @@ + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/footer.html b/documentation/staging/1.2/themes/learn/layouts/partials/footer.html new file mode 100644 index 000000000..091f80948 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/footer.html @@ -0,0 +1,83 @@ + {{ if .Params.chapter }} + + {{ end }} + + {{ partial "custom-comments.html" . }} + + + + + + +
    +
    +
    + + + + + + + + + + + {{ if (or (and (ne .Params.disableMermaid nil) (not .Params.disableMermaid)) (not .Site.Params.disableMermaid)) }} + {{ if isset .Params "customMermaidURL" }} + + {{ else if isset .Site.Params "customMermaidURL" }} + + {{ else }} + + {{ end }} + + {{ end }} + {{ partial "custom-footer.html" . }} + + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/header.html b/documentation/staging/1.2/themes/learn/layouts/partials/header.html new file mode 100644 index 000000000..8ee0334bc --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/header.html @@ -0,0 +1,112 @@ + + + + + + {{ hugo.Generator }} + {{ partial "meta.html" . }} + {{ partial "favicon.html" . }} + {{ .Title }} {{ default "::" .Site.Params.titleSeparator }} {{ .Site.Title }} + + {{ $assetBusting := not .Site.Params.disableAssetsBusting }} + + + + + + + + + + + {{with .Site.Params.themeVariant}} + + {{end}} + {{ range .Site.Params.custom_css -}} + + {{- end }} + + + + + {{ partial "custom-header.html" . }} + + + {{ partial "menu.html" . }} +
    +
    +
    + {{if not .IsHome}} +
    +
    + {{ if and (or .IsPage .IsSection) .Site.Params.editURL }} + {{ $File := .File }} + {{ $Site := .Site }} + {{with $File.Path }} + + {{ end }} + {{ end }} + {{$toc := (and (not .Params.disableToc) (not .Params.chapter))}} + + {{ if $toc }} + {{ partial "toc.html" . }} + {{ end }} +
    +
    + {{ end }} +
    + {{ partial "tags.html" . }} +
    + {{ if .Params.chapter }} +
    + {{ end }} +
    + {{if and (not .IsHome) (not .Params.chapter) }} +

    + {{ if or (eq .Kind "taxonomy") (eq .Kind "term") }} + {{.Data.Singular}} :: + {{ end }} + {{.Title}} +

    + {{end}} + + {{define "breadcrumb"}} + {{$parent := .page.Parent }} + {{ if $parent }} + {{ $value := (printf "%s > %s" $parent.RelPermalink $parent.Title .value) }} + {{ template "breadcrumb" dict "page" $parent "value" $value }} + {{else}} + {{.value|safeHTML}} + {{end}} + {{end}} diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/logo.html b/documentation/staging/1.2/themes/learn/layouts/partials/logo.html new file mode 100644 index 000000000..e66b2d574 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/logo.html @@ -0,0 +1,4 @@ + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/menu-footer.html b/documentation/staging/1.2/themes/learn/layouts/partials/menu-footer.html new file mode 100644 index 000000000..a51e58ea0 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/menu-footer.html @@ -0,0 +1,4 @@ +

    Created with from Oracle

    +

     

    +

    GitHub repo

    +

    Public Slack #weblogic

    diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/menu.html b/documentation/staging/1.2/themes/learn/layouts/partials/menu.html new file mode 100644 index 000000000..b2d8aab44 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/menu.html @@ -0,0 +1,160 @@ + + + +{{ define "section-tree-nav" }} +{{ $showvisitedlinks := .showvisitedlinks }} +{{ $currentNode := .currentnode }} +{{ $currentFileUniqueID := "" }} +{{ with $currentNode.File }}{{ $currentFileUniqueID = .UniqueID }}{{ end }} + {{with .sect}} + {{if and .IsSection (or (not .Params.hidden) $.showhidden)}} + {{safeHTML .Params.head}} +
  • + + {{safeHTML .Params.Pre}}{{or .Params.menuTitle .LinkTitle .Title}}{{safeHTML .Params.Post}} + {{ if $showvisitedlinks}} + + {{ end }} + + {{ $numberOfPages := (add (len ( where .Pages "Params.hidden" "ne" true )) (len ( where .Sections "Params.hidden" "ne" true ))) }} + {{ if ne $numberOfPages 0 }} +
      + {{ $currentNode.Scratch.Set "pages" .Pages }} + {{ if .Sections}} + {{ $currentNode.Scratch.Set "pages" (.Pages | union .Sections) }} + {{end}} + {{ $pages := ($currentNode.Scratch.Get "pages") }} + + {{if eq .Site.Params.ordersectionsby "title"}} + {{ range $pages.ByTitle }} + {{ if and .Params.hidden (not $.showhidden) }} + {{else}} + {{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks }} + {{end}} + {{ end }} + {{else}} + {{ range $pages.ByWeight }} + {{ if and .Params.hidden (not $.showhidden) }} + {{else}} + {{ template "section-tree-nav" dict "sect" . "currentnode" $currentNode "showvisitedlinks" $showvisitedlinks }} + {{end}} + {{ end }} + {{end}} +
    + {{ end }} +
    • + {{else}} + {{ if not .Params.Hidden }} +
  • + + {{safeHTML .Params.Pre}}{{or .Params.menuTitle .LinkTitle .Title}}{{safeHTML .Params.Post}} + {{ if $showvisitedlinks}}{{end}} + +
    • + {{ end }} + {{end}} + {{ end }} +{{ end }} diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/meta.html b/documentation/staging/1.2/themes/learn/layouts/partials/meta.html new file mode 100644 index 000000000..71d9634ef --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/meta.html @@ -0,0 +1,2 @@ + +{{ with .Site.Params.author }}{{ end }} diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/search.html b/documentation/staging/1.2/themes/learn/layouts/partials/search.html new file mode 100644 index 000000000..41daf84b9 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/search.html @@ -0,0 +1,16 @@ +
    + + + +
    +{{ $assetBusting := not .Site.Params.disableAssetsBusting }} + + + + diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/tags.html b/documentation/staging/1.2/themes/learn/layouts/partials/tags.html new file mode 100644 index 000000000..48790d87c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/tags.html @@ -0,0 +1,7 @@ +{{ if .Params.tags }} +
    +{{range .Params.tags}} + {{ . }} +{{end}} +
    +{{end}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/partials/toc.html b/documentation/staging/1.2/themes/learn/layouts/partials/toc.html new file mode 100644 index 000000000..6b69051f9 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/partials/toc.html @@ -0,0 +1,5 @@ +
    +
    +{{ .TableOfContents }} +
    +
    diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/attachments.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/attachments.html new file mode 100644 index 000000000..d688b7185 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/attachments.html @@ -0,0 +1,36 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +
    + + {{if eq .Page.File.BaseFileName "index"}} + {{$.Scratch.Add "filesName" "files"}} + {{else}} + {{$.Scratch.Add "filesName" (printf "%s.files" .Page.File.BaseFileName)}} + {{end}} +
    + {{ range (readDir (printf "./content/%s%s" .Page.File.Dir ($.Scratch.Get "filesName")) ) }} + {{ $fileDir := replace $.Page.File.Dir "\\" "/" }} + {{if ($.Get "pattern")}} + {{if (findRE ($.Get "pattern") .Name)}} +
  • + + {{.Name}} + + ({{div .Size 1024 }} {{T "BinaryPrefix-kilobyte"}}) +
    • + {{end}} + {{else}} +
  • + + {{.Name}} + + ({{div .Size 1024 }} {{T "BinaryPrefix-kilobyte"}}) +
    • + {{end}} + {{end}} +
    + {{.Inner}} +
    + diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/button.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/button.html new file mode 100644 index 000000000..7cfc38948 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/button.html @@ -0,0 +1,14 @@ +{{ $_hugo_config := `{ "version": 1 }` }} + + {{ $icon := .Get "icon" }} + {{ $iconposition := .Get "icon-position" }} + {{ if ($icon) }} + {{ if or (not ($iconposition)) (eq $iconposition "left") }} + + {{ end }} + {{ end }} + {{ .Inner }} + {{ if and ($icon) (eq $iconposition "right")}} + + {{ end }} + diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/children.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/children.html new file mode 100644 index 000000000..16688f257 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/children.html @@ -0,0 +1,99 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +{{ $showhidden := .Get "showhidden"}} +{{ $style := .Get "style" | default "li" }} +{{ $depth := .Get "depth" | default 1 }} +{{ $withDescription := .Get "description" | default false }} +{{ $sortTerm := .Get "sort" | default "Weight" }} + +
      + {{ .Scratch.Set "pages" .Page.Pages }} + + {{if .Page.IsHome}} + + {{ $rootPage := where .Page.Pages "Dir" "" }} + {{ .Scratch.Set "pages" (.Page.Sections | union $rootPage)}} + {{else}} + {{ if .Page.Sections}} + {{ .Scratch.Set "pages" (.Page.Pages | union .Page.Sections) }} + {{end}} + {{end}} + + {{ $pages := (.Scratch.Get "pages") }} + + {{if eq $sortTerm "Weight"}} + {{template "childs" dict "menu" $pages.ByWeight "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{else if eq $sortTerm "Name"}} + {{template "childs" dict "menu" $pages.ByTitle "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{else if eq $sortTerm "PublishDate"}} + {{template "childs" dict "menu" $pages.ByPublishDate "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{else if eq $sortTerm "Date"}} + {{template "childs" dict "menu" $pages.ByDate "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{else if eq $sortTerm "Length"}} + {{template "childs" dict "menu" $pages.ByLength "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{else}} + {{template "childs" dict "menu" $pages "style" $style "showhidden" $showhidden "count" 1 "depth" $depth "pages" .Site.Pages "description" $withDescription "sortTerm" $sortTerm}} + {{end}} +
    + +{{ define "childs" }} + {{ range .menu }} + {{ if and .Params.hidden (not $.showhidden) }} + {{else}} + {{if not .IsHome}} + {{if hasPrefix $.style "h"}} + {{$num := sub ( int (trim $.style "h") ) 1 }} + {{$numn := add $num $.count }} + +{{(printf "" $numn)|safeHTML}} +{{ .Title }} +{{(printf "" $numn)|safeHTML}} + + {{else}} +{{(printf "<%s>" $.style)|safeHTML}} +{{ .Title }} +{{(printf "" $.style)|safeHTML}} + {{end}} + + {{if $.description}} + {{if .Description}} +

    {{.Description}}

    + {{else}} +

    {{.Summary}}

    + {{end}} + {{end}} + {{end}} + {{ if lt $.count $.depth}} + + {{if eq $.style "li"}} +
      + {{end}} + + {{ if .Sections}} + {{ .Scratch.Set "pages" (.Pages | union .Sections) }} + {{else}} + {{ .Scratch.Set "pages" .Pages }} + {{end}} + + {{ $pages := (.Scratch.Get "pages") }} + + {{if eq $.sortTerm "Weight"}} + {{template "childs" dict "menu" $pages.ByWeight "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{else if eq $.sortTerm "Name"}} + {{template "childs" dict "menu" $pages.ByTitle "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{else if eq $.sortTerm "PublishDate"}} + {{template "childs" dict "menu" $pages.ByPublishDate "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{else if eq $.sortTerm "Date"}} + {{template "childs" dict "menu" $pages.ByDate "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{else if eq $.sortTerm "Length"}} + {{template "childs" dict "menu" $pages.ByLength "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{else}} + {{template "childs" dict "menu" $pages "style" $.style "showhidden" $.showhidden "count" (add $.count 1) "depth" $.depth "pages" $.pages "description" $.description "sortTerm" $.sortTerm}} + {{end}} + + {{if eq $.style "li"}} +
    + {{end}} + {{end}} + {{end}} + {{end}} +{{end}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/expand.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/expand.html new file mode 100644 index 000000000..0e7ddb186 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/expand.html @@ -0,0 +1,17 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +
    +
    + + + {{$expandMessage := T "Expand-title"}} + {{ if .IsNamedParams }} + {{.Get "default" | default $expandMessage}} + {{else}} + {{.Get 0 | default $expandMessage}} + {{end}} + +
    + +
    \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/himg.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/himg.html new file mode 100644 index 000000000..bd571d02b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/himg.html @@ -0,0 +1,8 @@ +
    +
    + {{ .Get 0 }} +
    +
    + {{ .Get 2 }} +
    +
    \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/mermaid.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/mermaid.html new file mode 100644 index 000000000..287bc380c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/mermaid.html @@ -0,0 +1,2 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +
    {{ safeHTML .Inner }}
    diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/notice.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/notice.html new file mode 100644 index 000000000..0e3324719 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/notice.html @@ -0,0 +1,2 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +
    {{ .Inner }}
    diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/ref.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/ref.html new file mode 100644 index 000000000..7b7eb426b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/ref.html @@ -0,0 +1,14 @@ +{{- if in (.Get 0) "/_index.md" -}} + {{- $paths := (split (.Get 0) "_index.md") -}} + {{- $pagepath := index $paths 0 -}} + {{- $anchor := index $paths 1 -}} + {{- with .Site.GetPage "section" (trim $pagepath "/") -}} + {{- ( printf "%s%s" $pagepath $anchor ) | relLangURL -}} + {{- end -}} +{{- else -}} + {{- with .Site.GetPage "section" (.Get 0) }} + {{- .RelPermalink -}} + {{- else -}} + {{- .Get 0 | relref .Page -}} + {{- end -}} +{{- end -}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/relref.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/relref.html new file mode 100644 index 000000000..7b7eb426b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/relref.html @@ -0,0 +1,14 @@ +{{- if in (.Get 0) "/_index.md" -}} + {{- $paths := (split (.Get 0) "_index.md") -}} + {{- $pagepath := index $paths 0 -}} + {{- $anchor := index $paths 1 -}} + {{- with .Site.GetPage "section" (trim $pagepath "/") -}} + {{- ( printf "%s%s" $pagepath $anchor ) | relLangURL -}} + {{- end -}} +{{- else -}} + {{- with .Site.GetPage "section" (.Get 0) }} + {{- .RelPermalink -}} + {{- else -}} + {{- .Get 0 | relref .Page -}} + {{- end -}} +{{- end -}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/siteparam.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/siteparam.html new file mode 100644 index 000000000..20cd2ca3b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/siteparam.html @@ -0,0 +1,7 @@ +{{- $paramName := (.Get 0) -}} +{{- $siteParams := .Site.Params -}} +{{- with $paramName -}} + {{- with $siteParams -}} + {{- index . (lower $paramName) -}} + {{- end -}} +{{- end -}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/tab.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/tab.html new file mode 100644 index 000000000..d258e00ac --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/tab.html @@ -0,0 +1,12 @@ +{{ if .Parent }} + {{ $name := trim (.Get "name") " " }} + {{ if not (.Parent.Scratch.Get "tabs") }} + {{ .Parent.Scratch.Set "tabs" slice }} + {{ end }} + {{ with .Inner }} + {{ $.Parent.Scratch.Add "tabs" (dict "name" $name "content" . ) }} + {{ end }} +{{ else }} + {{- errorf "[%s] %q: tab shortcode missing its parent" site.Language.Lang .Page.Path -}} +{{ end}} + diff --git a/documentation/staging/1.2/themes/learn/layouts/shortcodes/tabs.html b/documentation/staging/1.2/themes/learn/layouts/shortcodes/tabs.html new file mode 100644 index 000000000..417a80878 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/layouts/shortcodes/tabs.html @@ -0,0 +1,21 @@ +{{ with .Inner }}{{/* don't do anything, just call it */}}{{ end }} +{{ $groupId := default "default" (.Get "groupId") }} +
    +
    + {{ range $idx, $tab := .Scratch.Get "tabs" }} + + {{ end }} +
    +
    + {{ range $idx, $tab := .Scratch.Get "tabs" }} +
    + {{ .content }} +
    + {{ end }} +
    +
    diff --git a/documentation/staging/1.2/themes/learn/netlify.toml b/documentation/staging/1.2/themes/learn/netlify.toml new file mode 100644 index 000000000..86d04500b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/netlify.toml @@ -0,0 +1,23 @@ +[build] + publish = "exampleSite/public" + command = "hugo -s exampleSite" + +[build.environment] + HUGO_THEME = "repo" + HUGO_THEMESDIR = "/opt/build" + HUGO_VERSION = "0.72.0" + +[context.production.environment] + HUGO_BASEURL = "https://learn.netlify.app/" + +[context.deploy-preview] + command = "hugo -s exampleSite -b $DEPLOY_PRIME_URL" + +[context.deploy-preview.environment] + HUGO_ENABLEGITINFO = "true" + +[context.branch-deplpy] + command = "hugo -s exampleSite -b $DEPLOY_PRIME_URL" + +[context.branch-deploy.environment] + HUGO_ENABLEGITINFO = "true" diff --git a/documentation/staging/1.2/themes/learn/static/css/atom-one-dark-reasonable.css b/documentation/staging/1.2/themes/learn/static/css/atom-one-dark-reasonable.css new file mode 100644 index 000000000..fd41c996a --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/atom-one-dark-reasonable.css @@ -0,0 +1,77 @@ +/* + +Atom One Dark With support for ReasonML by Gidi Morris, based off work by Daniel Gamage + +Original One Dark Syntax theme from https://github.com/atom/one-dark-syntax + +*/ +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + line-height: 1.3em; + color: #abb2bf; + background: #282c34; + border-radius: 5px; +} +.hljs-keyword, .hljs-operator { + color: #F92672; +} +.hljs-pattern-match { + color: #F92672; +} +.hljs-pattern-match .hljs-constructor { + color: #61aeee; +} +.hljs-function { + color: #61aeee; +} +.hljs-function .hljs-params { + color: #A6E22E; +} +.hljs-function .hljs-params .hljs-typing { + color: #FD971F; +} +.hljs-module-access .hljs-module { + color: #7e57c2; +} +.hljs-constructor { + color: #e2b93d; +} +.hljs-constructor .hljs-string { + color: #9CCC65; +} +.hljs-comment, .hljs-quote { + color: #b18eb1; + font-style: italic; +} +.hljs-doctag, .hljs-formula { + color: #c678dd; +} +.hljs-section, .hljs-name, .hljs-selector-tag, .hljs-deletion, .hljs-subst { + color: #e06c75; +} +.hljs-literal { + color: #56b6c2; +} +.hljs-string, .hljs-regexp, .hljs-addition, .hljs-attribute, .hljs-meta-string { + color: #98c379; +} +.hljs-built_in, .hljs-class .hljs-title { + color: #e6c07b; +} +.hljs-attr, .hljs-variable, .hljs-template-variable, .hljs-type, .hljs-selector-class, .hljs-selector-attr, .hljs-selector-pseudo, .hljs-number { + color: #d19a66; +} +.hljs-symbol, .hljs-bullet, .hljs-link, .hljs-meta, .hljs-selector-id, .hljs-title { + color: #61aeee; +} +.hljs-emphasis { + font-style: italic; +} +.hljs-strong { + font-weight: bold; +} +.hljs-link { + text-decoration: underline; +} diff --git a/documentation/staging/1.2/themes/learn/static/css/auto-complete.css b/documentation/staging/1.2/themes/learn/static/css/auto-complete.css new file mode 100644 index 000000000..ac6979ad3 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/auto-complete.css @@ -0,0 +1,47 @@ +.autocomplete-suggestions { + text-align: left; + cursor: default; + border: 1px solid #ccc; + border-top: 0; + background: #fff; + box-shadow: -1px 1px 3px rgba(0,0,0,.1); + + /* core styles should not be changed */ + position: absolute; + display: none; + z-index: 9999; + max-height: 254px; + overflow: hidden; + overflow-y: auto; + box-sizing: border-box; + +} +.autocomplete-suggestion { + position: relative; + cursor: pointer; + padding: 7px; + line-height: 23px; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + color: #333; +} + +.autocomplete-suggestion b { + font-weight: normal; + color: #1f8dd6; +} + +.autocomplete-suggestion.selected { + background: #333; + color: #fff; +} + +.autocomplete-suggestion:hover { + background: #444; + color: #fff; +} + +.autocomplete-suggestion > .context { + font-size: 12px; +} diff --git a/documentation/staging/1.2/themes/learn/static/css/featherlight.min.css b/documentation/staging/1.2/themes/learn/static/css/featherlight.min.css new file mode 100644 index 000000000..058487f91 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/featherlight.min.css @@ -0,0 +1,8 @@ +/** + * Featherlight - ultra slim jQuery lightbox + * Version 1.7.13 - http://noelboss.github.io/featherlight/ + * + * Copyright 2018, Noël Raoul Bossart (http://www.noelboss.com) + * MIT Licensed. +**/ +html.with-featherlight{overflow:hidden}.featherlight{display:none;position:fixed;top:0;right:0;bottom:0;left:0;z-index:2147483647;text-align:center;white-space:nowrap;cursor:pointer;background:#333;background:rgba(0,0,0,0)}.featherlight:last-of-type{background:rgba(0,0,0,.8)}.featherlight:before{content:'';display:inline-block;height:100%;vertical-align:middle}.featherlight .featherlight-content{position:relative;text-align:left;vertical-align:middle;display:inline-block;overflow:auto;padding:25px 25px 0;border-bottom:25px solid transparent;margin-left:5%;margin-right:5%;max-height:95%;background:#fff;cursor:auto;white-space:normal}.featherlight .featherlight-inner{display:block}.featherlight link.featherlight-inner,.featherlight script.featherlight-inner,.featherlight style.featherlight-inner{display:none}.featherlight .featherlight-close-icon{position:absolute;z-index:9999;top:0;right:0;line-height:25px;width:25px;cursor:pointer;text-align:center;font-family:Arial,sans-serif;background:#fff;background:rgba(255,255,255,.3);color:#000;border:0;padding:0}.featherlight .featherlight-close-icon::-moz-focus-inner{border:0;padding:0}.featherlight .featherlight-image{width:100%}.featherlight-iframe .featherlight-content{border-bottom:0;padding:0;-webkit-overflow-scrolling:touch}.featherlight iframe{border:0}.featherlight *{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}@media only screen and (max-width:1024px){.featherlight .featherlight-content{margin-left:0;margin-right:0;max-height:98%;padding:10px 10px 0;border-bottom:10px solid transparent}}@media print{html.with-featherlight>*>:not(.featherlight){display:none}} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/fontawesome-all.min.css b/documentation/staging/1.2/themes/learn/static/css/fontawesome-all.min.css new file mode 100644 index 000000000..de5647372 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/fontawesome-all.min.css @@ -0,0 +1 @@ +.fa,.fab,.fal,.far,.fas{-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;display:inline-block;font-style:normal;font-variant:normal;text-rendering:auto;line-height:1}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-.0667em}.fa-xs{font-size:.75em}.fa-sm{font-size:.875em}.fa-1x{font-size:1em}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-6x{font-size:6em}.fa-7x{font-size:7em}.fa-8x{font-size:8em}.fa-9x{font-size:9em}.fa-10x{font-size:10em}.fa-fw{text-align:center;width:1.25em}.fa-ul{list-style-type:none;margin-left:2.5em;padding-left:0}.fa-ul>li{position:relative}.fa-li{left:-2em;position:absolute;text-align:center;width:2em;line-height:inherit}.fa-border{border:.08em solid #eee;border-radius:.1em;padding:.2em .25em .15em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.fab.fa-pull-left,.fal.fa-pull-left,.far.fa-pull-left,.fas.fa-pull-left{margin-right:.3em}.fa.fa-pull-right,.fab.fa-pull-right,.fal.fa-pull-right,.far.fa-pull-right,.fas.fa-pull-right{margin-left:.3em}.fa-spin{animation:fa-spin 2s infinite linear}.fa-pulse{animation:fa-spin 1s infinite steps(8)}@keyframes fa-spin{0%{transform:rotate(0deg)}to{transform:rotate(1turn)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";transform:scaleX(-1)}.fa-flip-vertical{transform:scaleY(-1)}.fa-flip-horizontal.fa-flip-vertical,.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)"}.fa-flip-horizontal.fa-flip-vertical{transform:scale(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{display:inline-block;height:2em;line-height:2em;position:relative;vertical-align:middle;width:2.5em}.fa-stack-1x,.fa-stack-2x{left:0;position:absolute;text-align:center;width:100%}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-500px:before{content:"\f26e"}.fa-accessible-icon:before{content:"\f368"}.fa-accusoft:before{content:"\f369"}.fa-acquisitions-incorporated:before{content:"\f6af"}.fa-ad:before{content:"\f641"}.fa-address-book:before{content:"\f2b9"}.fa-address-card:before{content:"\f2bb"}.fa-adjust:before{content:"\f042"}.fa-adn:before{content:"\f170"}.fa-adobe:before{content:"\f778"}.fa-adversal:before{content:"\f36a"}.fa-affiliatetheme:before{content:"\f36b"}.fa-air-freshener:before{content:"\f5d0"}.fa-algolia:before{content:"\f36c"}.fa-align-center:before{content:"\f037"}.fa-align-justify:before{content:"\f039"}.fa-align-left:before{content:"\f036"}.fa-align-right:before{content:"\f038"}.fa-alipay:before{content:"\f642"}.fa-allergies:before{content:"\f461"}.fa-amazon:before{content:"\f270"}.fa-amazon-pay:before{content:"\f42c"}.fa-ambulance:before{content:"\f0f9"}.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-amilia:before{content:"\f36d"}.fa-anchor:before{content:"\f13d"}.fa-android:before{content:"\f17b"}.fa-angellist:before{content:"\f209"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-down:before{content:"\f107"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angry:before{content:"\f556"}.fa-angrycreative:before{content:"\f36e"}.fa-angular:before{content:"\f420"}.fa-ankh:before{content:"\f644"}.fa-app-store:before{content:"\f36f"}.fa-app-store-ios:before{content:"\f370"}.fa-apper:before{content:"\f371"}.fa-apple:before{content:"\f179"}.fa-apple-alt:before{content:"\f5d1"}.fa-apple-pay:before{content:"\f415"}.fa-archive:before{content:"\f187"}.fa-archway:before{content:"\f557"}.fa-arrow-alt-circle-down:before{content:"\f358"}.fa-arrow-alt-circle-left:before{content:"\f359"}.fa-arrow-alt-circle-right:before{content:"\f35a"}.fa-arrow-alt-circle-up:before{content:"\f35b"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-down:before{content:"\f063"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrows-alt:before{content:"\f0b2"}.fa-arrows-alt-h:before{content:"\f337"}.fa-arrows-alt-v:before{content:"\f338"}.fa-artstation:before{content:"\f77a"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asterisk:before{content:"\f069"}.fa-asymmetrik:before{content:"\f372"}.fa-at:before{content:"\f1fa"}.fa-atlas:before{content:"\f558"}.fa-atlassian:before{content:"\f77b"}.fa-atom:before{content:"\f5d2"}.fa-audible:before{content:"\f373"}.fa-audio-description:before{content:"\f29e"}.fa-autoprefixer:before{content:"\f41c"}.fa-avianex:before{content:"\f374"}.fa-aviato:before{content:"\f421"}.fa-award:before{content:"\f559"}.fa-aws:before{content:"\f375"}.fa-baby:before{content:"\f77c"}.fa-baby-carriage:before{content:"\f77d"}.fa-backspace:before{content:"\f55a"}.fa-backward:before{content:"\f04a"}.fa-balance-scale:before{content:"\f24e"}.fa-ban:before{content:"\f05e"}.fa-band-aid:before{content:"\f462"}.fa-bandcamp:before{content:"\f2d5"}.fa-barcode:before{content:"\f02a"}.fa-bars:before{content:"\f0c9"}.fa-baseball-ball:before{content:"\f433"}.fa-basketball-ball:before{content:"\f434"}.fa-bath:before{content:"\f2cd"}.fa-battery-empty:before{content:"\f244"}.fa-battery-full:before{content:"\f240"}.fa-battery-half:before{content:"\f242"}.fa-battery-quarter:before{content:"\f243"}.fa-battery-three-quarters:before{content:"\f241"}.fa-bed:before{content:"\f236"}.fa-beer:before{content:"\f0fc"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-bell:before{content:"\f0f3"}.fa-bell-slash:before{content:"\f1f6"}.fa-bezier-curve:before{content:"\f55b"}.fa-bible:before{content:"\f647"}.fa-bicycle:before{content:"\f206"}.fa-bimobject:before{content:"\f378"}.fa-binoculars:before{content:"\f1e5"}.fa-biohazard:before{content:"\f780"}.fa-birthday-cake:before{content:"\f1fd"}.fa-bitbucket:before{content:"\f171"}.fa-bitcoin:before{content:"\f379"}.fa-bity:before{content:"\f37a"}.fa-black-tie:before{content:"\f27e"}.fa-blackberry:before{content:"\f37b"}.fa-blender:before{content:"\f517"}.fa-blender-phone:before{content:"\f6b6"}.fa-blind:before{content:"\f29d"}.fa-blog:before{content:"\f781"}.fa-blogger:before{content:"\f37c"}.fa-blogger-b:before{content:"\f37d"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-bold:before{content:"\f032"}.fa-bolt:before{content:"\f0e7"}.fa-bomb:before{content:"\f1e2"}.fa-bone:before{content:"\f5d7"}.fa-bong:before{content:"\f55c"}.fa-book:before{content:"\f02d"}.fa-book-dead:before{content:"\f6b7"}.fa-book-open:before{content:"\f518"}.fa-book-reader:before{content:"\f5da"}.fa-bookmark:before{content:"\f02e"}.fa-bowling-ball:before{content:"\f436"}.fa-box:before{content:"\f466"}.fa-box-open:before{content:"\f49e"}.fa-boxes:before{content:"\f468"}.fa-braille:before{content:"\f2a1"}.fa-brain:before{content:"\f5dc"}.fa-briefcase:before{content:"\f0b1"}.fa-briefcase-medical:before{content:"\f469"}.fa-broadcast-tower:before{content:"\f519"}.fa-broom:before{content:"\f51a"}.fa-brush:before{content:"\f55d"}.fa-btc:before{content:"\f15a"}.fa-bug:before{content:"\f188"}.fa-building:before{content:"\f1ad"}.fa-bullhorn:before{content:"\f0a1"}.fa-bullseye:before{content:"\f140"}.fa-burn:before{content:"\f46a"}.fa-buromobelexperte:before{content:"\f37f"}.fa-bus:before{content:"\f207"}.fa-bus-alt:before{content:"\f55e"}.fa-business-time:before{content:"\f64a"}.fa-buysellads:before{content:"\f20d"}.fa-calculator:before{content:"\f1ec"}.fa-calendar:before{content:"\f133"}.fa-calendar-alt:before{content:"\f073"}.fa-calendar-check:before{content:"\f274"}.fa-calendar-day:before{content:"\f783"}.fa-calendar-minus:before{content:"\f272"}.fa-calendar-plus:before{content:"\f271"}.fa-calendar-times:before{content:"\f273"}.fa-calendar-week:before{content:"\f784"}.fa-camera:before{content:"\f030"}.fa-camera-retro:before{content:"\f083"}.fa-campground:before{content:"\f6bb"}.fa-canadian-maple-leaf:before{content:"\f785"}.fa-candy-cane:before{content:"\f786"}.fa-cannabis:before{content:"\f55f"}.fa-capsules:before{content:"\f46b"}.fa-car:before{content:"\f1b9"}.fa-car-alt:before{content:"\f5de"}.fa-car-battery:before{content:"\f5df"}.fa-car-crash:before{content:"\f5e1"}.fa-car-side:before{content:"\f5e4"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-caret-square-down:before{content:"\f150"}.fa-caret-square-left:before{content:"\f191"}.fa-caret-square-right:before{content:"\f152"}.fa-caret-square-up:before{content:"\f151"}.fa-caret-up:before{content:"\f0d8"}.fa-carrot:before{content:"\f787"}.fa-cart-arrow-down:before{content:"\f218"}.fa-cart-plus:before{content:"\f217"}.fa-cash-register:before{content:"\f788"}.fa-cat:before{content:"\f6be"}.fa-cc-amazon-pay:before{content:"\f42d"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-apple-pay:before{content:"\f416"}.fa-cc-diners-club:before{content:"\f24c"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-cc-visa:before{content:"\f1f0"}.fa-centercode:before{content:"\f380"}.fa-centos:before{content:"\f789"}.fa-certificate:before{content:"\f0a3"}.fa-chair:before{content:"\f6c0"}.fa-chalkboard:before{content:"\f51b"}.fa-chalkboard-teacher:before{content:"\f51c"}.fa-charging-station:before{content:"\f5e7"}.fa-chart-area:before{content:"\f1fe"}.fa-chart-bar:before{content:"\f080"}.fa-chart-line:before{content:"\f201"}.fa-chart-pie:before{content:"\f200"}.fa-check:before{content:"\f00c"}.fa-check-circle:before{content:"\f058"}.fa-check-double:before{content:"\f560"}.fa-check-square:before{content:"\f14a"}.fa-chess:before{content:"\f439"}.fa-chess-bishop:before{content:"\f43a"}.fa-chess-board:before{content:"\f43c"}.fa-chess-king:before{content:"\f43f"}.fa-chess-knight:before{content:"\f441"}.fa-chess-pawn:before{content:"\f443"}.fa-chess-queen:before{content:"\f445"}.fa-chess-rook:before{content:"\f447"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-down:before{content:"\f078"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-chevron-up:before{content:"\f077"}.fa-child:before{content:"\f1ae"}.fa-chrome:before{content:"\f268"}.fa-church:before{content:"\f51d"}.fa-circle:before{content:"\f111"}.fa-circle-notch:before{content:"\f1ce"}.fa-city:before{content:"\f64f"}.fa-clipboard:before{content:"\f328"}.fa-clipboard-check:before{content:"\f46c"}.fa-clipboard-list:before{content:"\f46d"}.fa-clock:before{content:"\f017"}.fa-clone:before{content:"\f24d"}.fa-closed-captioning:before{content:"\f20a"}.fa-cloud:before{content:"\f0c2"}.fa-cloud-download-alt:before{content:"\f381"}.fa-cloud-meatball:before{content:"\f73b"}.fa-cloud-moon:before{content:"\f6c3"}.fa-cloud-moon-rain:before{content:"\f73c"}.fa-cloud-rain:before{content:"\f73d"}.fa-cloud-showers-heavy:before{content:"\f740"}.fa-cloud-sun:before{content:"\f6c4"}.fa-cloud-sun-rain:before{content:"\f743"}.fa-cloud-upload-alt:before{content:"\f382"}.fa-cloudscale:before{content:"\f383"}.fa-cloudsmith:before{content:"\f384"}.fa-cloudversify:before{content:"\f385"}.fa-cocktail:before{content:"\f561"}.fa-code:before{content:"\f121"}.fa-code-branch:before{content:"\f126"}.fa-codepen:before{content:"\f1cb"}.fa-codiepie:before{content:"\f284"}.fa-coffee:before{content:"\f0f4"}.fa-cog:before{content:"\f013"}.fa-cogs:before{content:"\f085"}.fa-coins:before{content:"\f51e"}.fa-columns:before{content:"\f0db"}.fa-comment:before{content:"\f075"}.fa-comment-alt:before{content:"\f27a"}.fa-comment-dollar:before{content:"\f651"}.fa-comment-dots:before{content:"\f4ad"}.fa-comment-slash:before{content:"\f4b3"}.fa-comments:before{content:"\f086"}.fa-comments-dollar:before{content:"\f653"}.fa-compact-disc:before{content:"\f51f"}.fa-compass:before{content:"\f14e"}.fa-compress:before{content:"\f066"}.fa-compress-arrows-alt:before{content:"\f78c"}.fa-concierge-bell:before{content:"\f562"}.fa-confluence:before{content:"\f78d"}.fa-connectdevelop:before{content:"\f20e"}.fa-contao:before{content:"\f26d"}.fa-cookie:before{content:"\f563"}.fa-cookie-bite:before{content:"\f564"}.fa-copy:before{content:"\f0c5"}.fa-copyright:before{content:"\f1f9"}.fa-couch:before{content:"\f4b8"}.fa-cpanel:before{content:"\f388"}.fa-creative-commons:before{content:"\f25e"}.fa-creative-commons-by:before{content:"\f4e7"}.fa-creative-commons-nc:before{content:"\f4e8"}.fa-creative-commons-nc-eu:before{content:"\f4e9"}.fa-creative-commons-nc-jp:before{content:"\f4ea"}.fa-creative-commons-nd:before{content:"\f4eb"}.fa-creative-commons-pd:before{content:"\f4ec"}.fa-creative-commons-pd-alt:before{content:"\f4ed"}.fa-creative-commons-remix:before{content:"\f4ee"}.fa-creative-commons-sa:before{content:"\f4ef"}.fa-creative-commons-sampling:before{content:"\f4f0"}.fa-creative-commons-sampling-plus:before{content:"\f4f1"}.fa-creative-commons-share:before{content:"\f4f2"}.fa-creative-commons-zero:before{content:"\f4f3"}.fa-credit-card:before{content:"\f09d"}.fa-critical-role:before{content:"\f6c9"}.fa-crop:before{content:"\f125"}.fa-crop-alt:before{content:"\f565"}.fa-cross:before{content:"\f654"}.fa-crosshairs:before{content:"\f05b"}.fa-crow:before{content:"\f520"}.fa-crown:before{content:"\f521"}.fa-css3:before{content:"\f13c"}.fa-css3-alt:before{content:"\f38b"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-cut:before{content:"\f0c4"}.fa-cuttlefish:before{content:"\f38c"}.fa-d-and-d:before{content:"\f38d"}.fa-d-and-d-beyond:before{content:"\f6ca"}.fa-dashcube:before{content:"\f210"}.fa-database:before{content:"\f1c0"}.fa-deaf:before{content:"\f2a4"}.fa-delicious:before{content:"\f1a5"}.fa-democrat:before{content:"\f747"}.fa-deploydog:before{content:"\f38e"}.fa-deskpro:before{content:"\f38f"}.fa-desktop:before{content:"\f108"}.fa-dev:before{content:"\f6cc"}.fa-deviantart:before{content:"\f1bd"}.fa-dharmachakra:before{content:"\f655"}.fa-dhl:before{content:"\f790"}.fa-diagnoses:before{content:"\f470"}.fa-diaspora:before{content:"\f791"}.fa-dice:before{content:"\f522"}.fa-dice-d20:before{content:"\f6cf"}.fa-dice-d6:before{content:"\f6d1"}.fa-dice-five:before{content:"\f523"}.fa-dice-four:before{content:"\f524"}.fa-dice-one:before{content:"\f525"}.fa-dice-six:before{content:"\f526"}.fa-dice-three:before{content:"\f527"}.fa-dice-two:before{content:"\f528"}.fa-digg:before{content:"\f1a6"}.fa-digital-ocean:before{content:"\f391"}.fa-digital-tachograph:before{content:"\f566"}.fa-directions:before{content:"\f5eb"}.fa-discord:before{content:"\f392"}.fa-discourse:before{content:"\f393"}.fa-divide:before{content:"\f529"}.fa-dizzy:before{content:"\f567"}.fa-dna:before{content:"\f471"}.fa-dochub:before{content:"\f394"}.fa-docker:before{content:"\f395"}.fa-dog:before{content:"\f6d3"}.fa-dollar-sign:before{content:"\f155"}.fa-dolly:before{content:"\f472"}.fa-dolly-flatbed:before{content:"\f474"}.fa-donate:before{content:"\f4b9"}.fa-door-closed:before{content:"\f52a"}.fa-door-open:before{content:"\f52b"}.fa-dot-circle:before{content:"\f192"}.fa-dove:before{content:"\f4ba"}.fa-download:before{content:"\f019"}.fa-draft2digital:before{content:"\f396"}.fa-drafting-compass:before{content:"\f568"}.fa-dragon:before{content:"\f6d5"}.fa-draw-polygon:before{content:"\f5ee"}.fa-dribbble:before{content:"\f17d"}.fa-dribbble-square:before{content:"\f397"}.fa-dropbox:before{content:"\f16b"}.fa-drum:before{content:"\f569"}.fa-drum-steelpan:before{content:"\f56a"}.fa-drumstick-bite:before{content:"\f6d7"}.fa-drupal:before{content:"\f1a9"}.fa-dumbbell:before{content:"\f44b"}.fa-dumpster:before{content:"\f793"}.fa-dumpster-fire:before{content:"\f794"}.fa-dungeon:before{content:"\f6d9"}.fa-dyalog:before{content:"\f399"}.fa-earlybirds:before{content:"\f39a"}.fa-ebay:before{content:"\f4f4"}.fa-edge:before{content:"\f282"}.fa-edit:before{content:"\f044"}.fa-eject:before{content:"\f052"}.fa-elementor:before{content:"\f430"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-ello:before{content:"\f5f1"}.fa-ember:before{content:"\f423"}.fa-empire:before{content:"\f1d1"}.fa-envelope:before{content:"\f0e0"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-text:before{content:"\f658"}.fa-envelope-square:before{content:"\f199"}.fa-envira:before{content:"\f299"}.fa-equals:before{content:"\f52c"}.fa-eraser:before{content:"\f12d"}.fa-erlang:before{content:"\f39d"}.fa-ethereum:before{content:"\f42e"}.fa-ethernet:before{content:"\f796"}.fa-etsy:before{content:"\f2d7"}.fa-euro-sign:before{content:"\f153"}.fa-exchange-alt:before{content:"\f362"}.fa-exclamation:before{content:"\f12a"}.fa-exclamation-circle:before{content:"\f06a"}.fa-exclamation-triangle:before{content:"\f071"}.fa-expand:before{content:"\f065"}.fa-expand-arrows-alt:before{content:"\f31e"}.fa-expeditedssl:before{content:"\f23e"}.fa-external-link-alt:before{content:"\f35d"}.fa-external-link-square-alt:before{content:"\f360"}.fa-eye:before{content:"\f06e"}.fa-eye-dropper:before{content:"\f1fb"}.fa-eye-slash:before{content:"\f070"}.fa-facebook:before{content:"\f09a"}.fa-facebook-f:before{content:"\f39e"}.fa-facebook-messenger:before{content:"\f39f"}.fa-facebook-square:before{content:"\f082"}.fa-fantasy-flight-games:before{content:"\f6dc"}.fa-fast-backward:before{content:"\f049"}.fa-fast-forward:before{content:"\f050"}.fa-fax:before{content:"\f1ac"}.fa-feather:before{content:"\f52d"}.fa-feather-alt:before{content:"\f56b"}.fa-fedex:before{content:"\f797"}.fa-fedora:before{content:"\f798"}.fa-female:before{content:"\f182"}.fa-fighter-jet:before{content:"\f0fb"}.fa-figma:before{content:"\f799"}.fa-file:before{content:"\f15b"}.fa-file-alt:before{content:"\f15c"}.fa-file-archive:before{content:"\f1c6"}.fa-file-audio:before{content:"\f1c7"}.fa-file-code:before{content:"\f1c9"}.fa-file-contract:before{content:"\f56c"}.fa-file-csv:before{content:"\f6dd"}.fa-file-download:before{content:"\f56d"}.fa-file-excel:before{content:"\f1c3"}.fa-file-export:before{content:"\f56e"}.fa-file-image:before{content:"\f1c5"}.fa-file-import:before{content:"\f56f"}.fa-file-invoice:before{content:"\f570"}.fa-file-invoice-dollar:before{content:"\f571"}.fa-file-medical:before{content:"\f477"}.fa-file-medical-alt:before{content:"\f478"}.fa-file-pdf:before{content:"\f1c1"}.fa-file-powerpoint:before{content:"\f1c4"}.fa-file-prescription:before{content:"\f572"}.fa-file-signature:before{content:"\f573"}.fa-file-upload:before{content:"\f574"}.fa-file-video:before{content:"\f1c8"}.fa-file-word:before{content:"\f1c2"}.fa-fill:before{content:"\f575"}.fa-fill-drip:before{content:"\f576"}.fa-film:before{content:"\f008"}.fa-filter:before{content:"\f0b0"}.fa-fingerprint:before{content:"\f577"}.fa-fire:before{content:"\f06d"}.fa-fire-alt:before{content:"\f7e4"}.fa-fire-extinguisher:before{content:"\f134"}.fa-firefox:before{content:"\f269"}.fa-first-aid:before{content:"\f479"}.fa-first-order:before{content:"\f2b0"}.fa-first-order-alt:before{content:"\f50a"}.fa-firstdraft:before{content:"\f3a1"}.fa-fish:before{content:"\f578"}.fa-fist-raised:before{content:"\f6de"}.fa-flag:before{content:"\f024"}.fa-flag-checkered:before{content:"\f11e"}.fa-flag-usa:before{content:"\f74d"}.fa-flask:before{content:"\f0c3"}.fa-flickr:before{content:"\f16e"}.fa-flipboard:before{content:"\f44d"}.fa-flushed:before{content:"\f579"}.fa-fly:before{content:"\f417"}.fa-folder:before{content:"\f07b"}.fa-folder-minus:before{content:"\f65d"}.fa-folder-open:before{content:"\f07c"}.fa-folder-plus:before{content:"\f65e"}.fa-font:before{content:"\f031"}.fa-font-awesome:before{content:"\f2b4"}.fa-font-awesome-alt:before{content:"\f35c"}.fa-font-awesome-flag:before{content:"\f425"}.fa-font-awesome-logo-full:before{content:"\f4e6"}.fa-fonticons:before{content:"\f280"}.fa-fonticons-fi:before{content:"\f3a2"}.fa-football-ball:before{content:"\f44e"}.fa-fort-awesome:before{content:"\f286"}.fa-fort-awesome-alt:before{content:"\f3a3"}.fa-forumbee:before{content:"\f211"}.fa-forward:before{content:"\f04e"}.fa-foursquare:before{content:"\f180"}.fa-free-code-camp:before{content:"\f2c5"}.fa-freebsd:before{content:"\f3a4"}.fa-frog:before{content:"\f52e"}.fa-frown:before{content:"\f119"}.fa-frown-open:before{content:"\f57a"}.fa-fulcrum:before{content:"\f50b"}.fa-funnel-dollar:before{content:"\f662"}.fa-futbol:before{content:"\f1e3"}.fa-galactic-republic:before{content:"\f50c"}.fa-galactic-senate:before{content:"\f50d"}.fa-gamepad:before{content:"\f11b"}.fa-gas-pump:before{content:"\f52f"}.fa-gavel:before{content:"\f0e3"}.fa-gem:before{content:"\f3a5"}.fa-genderless:before{content:"\f22d"}.fa-get-pocket:before{content:"\f265"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-ghost:before{content:"\f6e2"}.fa-gift:before{content:"\f06b"}.fa-gifts:before{content:"\f79c"}.fa-git:before{content:"\f1d3"}.fa-git-square:before{content:"\f1d2"}.fa-github:before{content:"\f09b"}.fa-github-alt:before{content:"\f113"}.fa-github-square:before{content:"\f092"}.fa-gitkraken:before{content:"\f3a6"}.fa-gitlab:before{content:"\f296"}.fa-gitter:before{content:"\f426"}.fa-glass-cheers:before{content:"\f79f"}.fa-glass-martini:before{content:"\f000"}.fa-glass-martini-alt:before{content:"\f57b"}.fa-glass-whiskey:before{content:"\f7a0"}.fa-glasses:before{content:"\f530"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-globe:before{content:"\f0ac"}.fa-globe-africa:before{content:"\f57c"}.fa-globe-americas:before{content:"\f57d"}.fa-globe-asia:before{content:"\f57e"}.fa-globe-europe:before{content:"\f7a2"}.fa-gofore:before{content:"\f3a7"}.fa-golf-ball:before{content:"\f450"}.fa-goodreads:before{content:"\f3a8"}.fa-goodreads-g:before{content:"\f3a9"}.fa-google:before{content:"\f1a0"}.fa-google-drive:before{content:"\f3aa"}.fa-google-play:before{content:"\f3ab"}.fa-google-plus:before{content:"\f2b3"}.fa-google-plus-g:before{content:"\f0d5"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-wallet:before{content:"\f1ee"}.fa-gopuram:before{content:"\f664"}.fa-graduation-cap:before{content:"\f19d"}.fa-gratipay:before{content:"\f184"}.fa-grav:before{content:"\f2d6"}.fa-greater-than:before{content:"\f531"}.fa-greater-than-equal:before{content:"\f532"}.fa-grimace:before{content:"\f57f"}.fa-grin:before{content:"\f580"}.fa-grin-alt:before{content:"\f581"}.fa-grin-beam:before{content:"\f582"}.fa-grin-beam-sweat:before{content:"\f583"}.fa-grin-hearts:before{content:"\f584"}.fa-grin-squint:before{content:"\f585"}.fa-grin-squint-tears:before{content:"\f586"}.fa-grin-stars:before{content:"\f587"}.fa-grin-tears:before{content:"\f588"}.fa-grin-tongue:before{content:"\f589"}.fa-grin-tongue-squint:before{content:"\f58a"}.fa-grin-tongue-wink:before{content:"\f58b"}.fa-grin-wink:before{content:"\f58c"}.fa-grip-horizontal:before{content:"\f58d"}.fa-grip-lines:before{content:"\f7a4"}.fa-grip-lines-vertical:before{content:"\f7a5"}.fa-grip-vertical:before{content:"\f58e"}.fa-gripfire:before{content:"\f3ac"}.fa-grunt:before{content:"\f3ad"}.fa-guitar:before{content:"\f7a6"}.fa-gulp:before{content:"\f3ae"}.fa-h-square:before{content:"\f0fd"}.fa-hacker-news:before{content:"\f1d4"}.fa-hacker-news-square:before{content:"\f3af"}.fa-hackerrank:before{content:"\f5f7"}.fa-hammer:before{content:"\f6e3"}.fa-hamsa:before{content:"\f665"}.fa-hand-holding:before{content:"\f4bd"}.fa-hand-holding-heart:before{content:"\f4be"}.fa-hand-holding-usd:before{content:"\f4c0"}.fa-hand-lizard:before{content:"\f258"}.fa-hand-paper:before{content:"\f256"}.fa-hand-peace:before{content:"\f25b"}.fa-hand-point-down:before{content:"\f0a7"}.fa-hand-point-left:before{content:"\f0a5"}.fa-hand-point-right:before{content:"\f0a4"}.fa-hand-point-up:before{content:"\f0a6"}.fa-hand-pointer:before{content:"\f25a"}.fa-hand-rock:before{content:"\f255"}.fa-hand-scissors:before{content:"\f257"}.fa-hand-spock:before{content:"\f259"}.fa-hands:before{content:"\f4c2"}.fa-hands-helping:before{content:"\f4c4"}.fa-handshake:before{content:"\f2b5"}.fa-hanukiah:before{content:"\f6e6"}.fa-hashtag:before{content:"\f292"}.fa-hat-wizard:before{content:"\f6e8"}.fa-haykal:before{content:"\f666"}.fa-hdd:before{content:"\f0a0"}.fa-heading:before{content:"\f1dc"}.fa-headphones:before{content:"\f025"}.fa-headphones-alt:before{content:"\f58f"}.fa-headset:before{content:"\f590"}.fa-heart:before{content:"\f004"}.fa-heart-broken:before{content:"\f7a9"}.fa-heartbeat:before{content:"\f21e"}.fa-helicopter:before{content:"\f533"}.fa-highlighter:before{content:"\f591"}.fa-hiking:before{content:"\f6ec"}.fa-hippo:before{content:"\f6ed"}.fa-hips:before{content:"\f452"}.fa-hire-a-helper:before{content:"\f3b0"}.fa-history:before{content:"\f1da"}.fa-hockey-puck:before{content:"\f453"}.fa-holly-berry:before{content:"\f7aa"}.fa-home:before{content:"\f015"}.fa-hooli:before{content:"\f427"}.fa-hornbill:before{content:"\f592"}.fa-horse:before{content:"\f6f0"}.fa-horse-head:before{content:"\f7ab"}.fa-hospital:before{content:"\f0f8"}.fa-hospital-alt:before{content:"\f47d"}.fa-hospital-symbol:before{content:"\f47e"}.fa-hot-tub:before{content:"\f593"}.fa-hotel:before{content:"\f594"}.fa-hotjar:before{content:"\f3b1"}.fa-hourglass:before{content:"\f254"}.fa-hourglass-end:before{content:"\f253"}.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-start:before{content:"\f251"}.fa-house-damage:before{content:"\f6f1"}.fa-houzz:before{content:"\f27c"}.fa-hryvnia:before{content:"\f6f2"}.fa-html5:before{content:"\f13b"}.fa-hubspot:before{content:"\f3b2"}.fa-i-cursor:before{content:"\f246"}.fa-icicles:before{content:"\f7ad"}.fa-id-badge:before{content:"\f2c1"}.fa-id-card:before{content:"\f2c2"}.fa-id-card-alt:before{content:"\f47f"}.fa-igloo:before{content:"\f7ae"}.fa-image:before{content:"\f03e"}.fa-images:before{content:"\f302"}.fa-imdb:before{content:"\f2d8"}.fa-inbox:before{content:"\f01c"}.fa-indent:before{content:"\f03c"}.fa-industry:before{content:"\f275"}.fa-infinity:before{content:"\f534"}.fa-info:before{content:"\f129"}.fa-info-circle:before{content:"\f05a"}.fa-instagram:before{content:"\f16d"}.fa-intercom:before{content:"\f7af"}.fa-internet-explorer:before{content:"\f26b"}.fa-invision:before{content:"\f7b0"}.fa-ioxhost:before{content:"\f208"}.fa-italic:before{content:"\f033"}.fa-itunes:before{content:"\f3b4"}.fa-itunes-note:before{content:"\f3b5"}.fa-java:before{content:"\f4e4"}.fa-jedi:before{content:"\f669"}.fa-jedi-order:before{content:"\f50e"}.fa-jenkins:before{content:"\f3b6"}.fa-jira:before{content:"\f7b1"}.fa-joget:before{content:"\f3b7"}.fa-joint:before{content:"\f595"}.fa-joomla:before{content:"\f1aa"}.fa-journal-whills:before{content:"\f66a"}.fa-js:before{content:"\f3b8"}.fa-js-square:before{content:"\f3b9"}.fa-jsfiddle:before{content:"\f1cc"}.fa-kaaba:before{content:"\f66b"}.fa-kaggle:before{content:"\f5fa"}.fa-key:before{content:"\f084"}.fa-keybase:before{content:"\f4f5"}.fa-keyboard:before{content:"\f11c"}.fa-keycdn:before{content:"\f3ba"}.fa-khanda:before{content:"\f66d"}.fa-kickstarter:before{content:"\f3bb"}.fa-kickstarter-k:before{content:"\f3bc"}.fa-kiss:before{content:"\f596"}.fa-kiss-beam:before{content:"\f597"}.fa-kiss-wink-heart:before{content:"\f598"}.fa-kiwi-bird:before{content:"\f535"}.fa-korvue:before{content:"\f42f"}.fa-landmark:before{content:"\f66f"}.fa-language:before{content:"\f1ab"}.fa-laptop:before{content:"\f109"}.fa-laptop-code:before{content:"\f5fc"}.fa-laravel:before{content:"\f3bd"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-laugh:before{content:"\f599"}.fa-laugh-beam:before{content:"\f59a"}.fa-laugh-squint:before{content:"\f59b"}.fa-laugh-wink:before{content:"\f59c"}.fa-layer-group:before{content:"\f5fd"}.fa-leaf:before{content:"\f06c"}.fa-leanpub:before{content:"\f212"}.fa-lemon:before{content:"\f094"}.fa-less:before{content:"\f41d"}.fa-less-than:before{content:"\f536"}.fa-less-than-equal:before{content:"\f537"}.fa-level-down-alt:before{content:"\f3be"}.fa-level-up-alt:before{content:"\f3bf"}.fa-life-ring:before{content:"\f1cd"}.fa-lightbulb:before{content:"\f0eb"}.fa-line:before{content:"\f3c0"}.fa-link:before{content:"\f0c1"}.fa-linkedin:before{content:"\f08c"}.fa-linkedin-in:before{content:"\f0e1"}.fa-linode:before{content:"\f2b8"}.fa-linux:before{content:"\f17c"}.fa-lira-sign:before{content:"\f195"}.fa-list:before{content:"\f03a"}.fa-list-alt:before{content:"\f022"}.fa-list-ol:before{content:"\f0cb"}.fa-list-ul:before{content:"\f0ca"}.fa-location-arrow:before{content:"\f124"}.fa-lock:before{content:"\f023"}.fa-lock-open:before{content:"\f3c1"}.fa-long-arrow-alt-down:before{content:"\f309"}.fa-long-arrow-alt-left:before{content:"\f30a"}.fa-long-arrow-alt-right:before{content:"\f30b"}.fa-long-arrow-alt-up:before{content:"\f30c"}.fa-low-vision:before{content:"\f2a8"}.fa-luggage-cart:before{content:"\f59d"}.fa-lyft:before{content:"\f3c3"}.fa-magento:before{content:"\f3c4"}.fa-magic:before{content:"\f0d0"}.fa-magnet:before{content:"\f076"}.fa-mail-bulk:before{content:"\f674"}.fa-mailchimp:before{content:"\f59e"}.fa-male:before{content:"\f183"}.fa-mandalorian:before{content:"\f50f"}.fa-map:before{content:"\f279"}.fa-map-marked:before{content:"\f59f"}.fa-map-marked-alt:before{content:"\f5a0"}.fa-map-marker:before{content:"\f041"}.fa-map-marker-alt:before{content:"\f3c5"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-markdown:before{content:"\f60f"}.fa-marker:before{content:"\f5a1"}.fa-mars:before{content:"\f222"}.fa-mars-double:before{content:"\f227"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mask:before{content:"\f6fa"}.fa-mastodon:before{content:"\f4f6"}.fa-maxcdn:before{content:"\f136"}.fa-medal:before{content:"\f5a2"}.fa-medapps:before{content:"\f3c6"}.fa-medium:before{content:"\f23a"}.fa-medium-m:before{content:"\f3c7"}.fa-medkit:before{content:"\f0fa"}.fa-medrt:before{content:"\f3c8"}.fa-meetup:before{content:"\f2e0"}.fa-megaport:before{content:"\f5a3"}.fa-meh:before{content:"\f11a"}.fa-meh-blank:before{content:"\f5a4"}.fa-meh-rolling-eyes:before{content:"\f5a5"}.fa-memory:before{content:"\f538"}.fa-mendeley:before{content:"\f7b3"}.fa-menorah:before{content:"\f676"}.fa-mercury:before{content:"\f223"}.fa-meteor:before{content:"\f753"}.fa-microchip:before{content:"\f2db"}.fa-microphone:before{content:"\f130"}.fa-microphone-alt:before{content:"\f3c9"}.fa-microphone-alt-slash:before{content:"\f539"}.fa-microphone-slash:before{content:"\f131"}.fa-microscope:before{content:"\f610"}.fa-microsoft:before{content:"\f3ca"}.fa-minus:before{content:"\f068"}.fa-minus-circle:before{content:"\f056"}.fa-minus-square:before{content:"\f146"}.fa-mitten:before{content:"\f7b5"}.fa-mix:before{content:"\f3cb"}.fa-mixcloud:before{content:"\f289"}.fa-mizuni:before{content:"\f3cc"}.fa-mobile:before{content:"\f10b"}.fa-mobile-alt:before{content:"\f3cd"}.fa-modx:before{content:"\f285"}.fa-monero:before{content:"\f3d0"}.fa-money-bill:before{content:"\f0d6"}.fa-money-bill-alt:before{content:"\f3d1"}.fa-money-bill-wave:before{content:"\f53a"}.fa-money-bill-wave-alt:before{content:"\f53b"}.fa-money-check:before{content:"\f53c"}.fa-money-check-alt:before{content:"\f53d"}.fa-monument:before{content:"\f5a6"}.fa-moon:before{content:"\f186"}.fa-mortar-pestle:before{content:"\f5a7"}.fa-mosque:before{content:"\f678"}.fa-motorcycle:before{content:"\f21c"}.fa-mountain:before{content:"\f6fc"}.fa-mouse-pointer:before{content:"\f245"}.fa-mug-hot:before{content:"\f7b6"}.fa-music:before{content:"\f001"}.fa-napster:before{content:"\f3d2"}.fa-neos:before{content:"\f612"}.fa-network-wired:before{content:"\f6ff"}.fa-neuter:before{content:"\f22c"}.fa-newspaper:before{content:"\f1ea"}.fa-nimblr:before{content:"\f5a8"}.fa-nintendo-switch:before{content:"\f418"}.fa-node:before{content:"\f419"}.fa-node-js:before{content:"\f3d3"}.fa-not-equal:before{content:"\f53e"}.fa-notes-medical:before{content:"\f481"}.fa-npm:before{content:"\f3d4"}.fa-ns8:before{content:"\f3d5"}.fa-nutritionix:before{content:"\f3d6"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-oil-can:before{content:"\f613"}.fa-old-republic:before{content:"\f510"}.fa-om:before{content:"\f679"}.fa-opencart:before{content:"\f23d"}.fa-openid:before{content:"\f19b"}.fa-opera:before{content:"\f26a"}.fa-optin-monster:before{content:"\f23c"}.fa-osi:before{content:"\f41a"}.fa-otter:before{content:"\f700"}.fa-outdent:before{content:"\f03b"}.fa-page4:before{content:"\f3d7"}.fa-pagelines:before{content:"\f18c"}.fa-paint-brush:before{content:"\f1fc"}.fa-paint-roller:before{content:"\f5aa"}.fa-palette:before{content:"\f53f"}.fa-palfed:before{content:"\f3d8"}.fa-pallet:before{content:"\f482"}.fa-paper-plane:before{content:"\f1d8"}.fa-paperclip:before{content:"\f0c6"}.fa-parachute-box:before{content:"\f4cd"}.fa-paragraph:before{content:"\f1dd"}.fa-parking:before{content:"\f540"}.fa-passport:before{content:"\f5ab"}.fa-pastafarianism:before{content:"\f67b"}.fa-paste:before{content:"\f0ea"}.fa-patreon:before{content:"\f3d9"}.fa-pause:before{content:"\f04c"}.fa-pause-circle:before{content:"\f28b"}.fa-paw:before{content:"\f1b0"}.fa-paypal:before{content:"\f1ed"}.fa-peace:before{content:"\f67c"}.fa-pen:before{content:"\f304"}.fa-pen-alt:before{content:"\f305"}.fa-pen-fancy:before{content:"\f5ac"}.fa-pen-nib:before{content:"\f5ad"}.fa-pen-square:before{content:"\f14b"}.fa-pencil-alt:before{content:"\f303"}.fa-pencil-ruler:before{content:"\f5ae"}.fa-penny-arcade:before{content:"\f704"}.fa-people-carry:before{content:"\f4ce"}.fa-percent:before{content:"\f295"}.fa-percentage:before{content:"\f541"}.fa-periscope:before{content:"\f3da"}.fa-person-booth:before{content:"\f756"}.fa-phabricator:before{content:"\f3db"}.fa-phoenix-framework:before{content:"\f3dc"}.fa-phoenix-squadron:before{content:"\f511"}.fa-phone:before{content:"\f095"}.fa-phone-slash:before{content:"\f3dd"}.fa-phone-square:before{content:"\f098"}.fa-phone-volume:before{content:"\f2a0"}.fa-php:before{content:"\f457"}.fa-pied-piper:before{content:"\f2ae"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-pied-piper-hat:before{content:"\f4e5"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-piggy-bank:before{content:"\f4d3"}.fa-pills:before{content:"\f484"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-p:before{content:"\f231"}.fa-pinterest-square:before{content:"\f0d3"}.fa-place-of-worship:before{content:"\f67f"}.fa-plane:before{content:"\f072"}.fa-plane-arrival:before{content:"\f5af"}.fa-plane-departure:before{content:"\f5b0"}.fa-play:before{content:"\f04b"}.fa-play-circle:before{content:"\f144"}.fa-playstation:before{content:"\f3df"}.fa-plug:before{content:"\f1e6"}.fa-plus:before{content:"\f067"}.fa-plus-circle:before{content:"\f055"}.fa-plus-square:before{content:"\f0fe"}.fa-podcast:before{content:"\f2ce"}.fa-poll:before{content:"\f681"}.fa-poll-h:before{content:"\f682"}.fa-poo:before{content:"\f2fe"}.fa-poo-storm:before{content:"\f75a"}.fa-poop:before{content:"\f619"}.fa-portrait:before{content:"\f3e0"}.fa-pound-sign:before{content:"\f154"}.fa-power-off:before{content:"\f011"}.fa-pray:before{content:"\f683"}.fa-praying-hands:before{content:"\f684"}.fa-prescription:before{content:"\f5b1"}.fa-prescription-bottle:before{content:"\f485"}.fa-prescription-bottle-alt:before{content:"\f486"}.fa-print:before{content:"\f02f"}.fa-procedures:before{content:"\f487"}.fa-product-hunt:before{content:"\f288"}.fa-project-diagram:before{content:"\f542"}.fa-pushed:before{content:"\f3e1"}.fa-puzzle-piece:before{content:"\f12e"}.fa-python:before{content:"\f3e2"}.fa-qq:before{content:"\f1d6"}.fa-qrcode:before{content:"\f029"}.fa-question:before{content:"\f128"}.fa-question-circle:before{content:"\f059"}.fa-quidditch:before{content:"\f458"}.fa-quinscape:before{content:"\f459"}.fa-quora:before{content:"\f2c4"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-quran:before{content:"\f687"}.fa-r-project:before{content:"\f4f7"}.fa-radiation:before{content:"\f7b9"}.fa-radiation-alt:before{content:"\f7ba"}.fa-rainbow:before{content:"\f75b"}.fa-random:before{content:"\f074"}.fa-raspberry-pi:before{content:"\f7bb"}.fa-ravelry:before{content:"\f2d9"}.fa-react:before{content:"\f41b"}.fa-reacteurope:before{content:"\f75d"}.fa-readme:before{content:"\f4d5"}.fa-rebel:before{content:"\f1d0"}.fa-receipt:before{content:"\f543"}.fa-recycle:before{content:"\f1b8"}.fa-red-river:before{content:"\f3e3"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-alien:before{content:"\f281"}.fa-reddit-square:before{content:"\f1a2"}.fa-redhat:before{content:"\f7bc"}.fa-redo:before{content:"\f01e"}.fa-redo-alt:before{content:"\f2f9"}.fa-registered:before{content:"\f25d"}.fa-renren:before{content:"\f18b"}.fa-reply:before{content:"\f3e5"}.fa-reply-all:before{content:"\f122"}.fa-replyd:before{content:"\f3e6"}.fa-republican:before{content:"\f75e"}.fa-researchgate:before{content:"\f4f8"}.fa-resolving:before{content:"\f3e7"}.fa-restroom:before{content:"\f7bd"}.fa-retweet:before{content:"\f079"}.fa-rev:before{content:"\f5b2"}.fa-ribbon:before{content:"\f4d6"}.fa-ring:before{content:"\f70b"}.fa-road:before{content:"\f018"}.fa-robot:before{content:"\f544"}.fa-rocket:before{content:"\f135"}.fa-rocketchat:before{content:"\f3e8"}.fa-rockrms:before{content:"\f3e9"}.fa-route:before{content:"\f4d7"}.fa-rss:before{content:"\f09e"}.fa-rss-square:before{content:"\f143"}.fa-ruble-sign:before{content:"\f158"}.fa-ruler:before{content:"\f545"}.fa-ruler-combined:before{content:"\f546"}.fa-ruler-horizontal:before{content:"\f547"}.fa-ruler-vertical:before{content:"\f548"}.fa-running:before{content:"\f70c"}.fa-rupee-sign:before{content:"\f156"}.fa-sad-cry:before{content:"\f5b3"}.fa-sad-tear:before{content:"\f5b4"}.fa-safari:before{content:"\f267"}.fa-sass:before{content:"\f41e"}.fa-satellite:before{content:"\f7bf"}.fa-satellite-dish:before{content:"\f7c0"}.fa-save:before{content:"\f0c7"}.fa-schlix:before{content:"\f3ea"}.fa-school:before{content:"\f549"}.fa-screwdriver:before{content:"\f54a"}.fa-scribd:before{content:"\f28a"}.fa-scroll:before{content:"\f70e"}.fa-sd-card:before{content:"\f7c2"}.fa-search:before{content:"\f002"}.fa-search-dollar:before{content:"\f688"}.fa-search-location:before{content:"\f689"}.fa-search-minus:before{content:"\f010"}.fa-search-plus:before{content:"\f00e"}.fa-searchengin:before{content:"\f3eb"}.fa-seedling:before{content:"\f4d8"}.fa-sellcast:before{content:"\f2da"}.fa-sellsy:before{content:"\f213"}.fa-server:before{content:"\f233"}.fa-servicestack:before{content:"\f3ec"}.fa-shapes:before{content:"\f61f"}.fa-share:before{content:"\f064"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-share-square:before{content:"\f14d"}.fa-shekel-sign:before{content:"\f20b"}.fa-shield-alt:before{content:"\f3ed"}.fa-ship:before{content:"\f21a"}.fa-shipping-fast:before{content:"\f48b"}.fa-shirtsinbulk:before{content:"\f214"}.fa-shoe-prints:before{content:"\f54b"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-shopping-cart:before{content:"\f07a"}.fa-shopware:before{content:"\f5b5"}.fa-shower:before{content:"\f2cc"}.fa-shuttle-van:before{content:"\f5b6"}.fa-sign:before{content:"\f4d9"}.fa-sign-in-alt:before{content:"\f2f6"}.fa-sign-language:before{content:"\f2a7"}.fa-sign-out-alt:before{content:"\f2f5"}.fa-signal:before{content:"\f012"}.fa-signature:before{content:"\f5b7"}.fa-sim-card:before{content:"\f7c4"}.fa-simplybuilt:before{content:"\f215"}.fa-sistrix:before{content:"\f3ee"}.fa-sitemap:before{content:"\f0e8"}.fa-sith:before{content:"\f512"}.fa-skating:before{content:"\f7c5"}.fa-sketch:before{content:"\f7c6"}.fa-skiing:before{content:"\f7c9"}.fa-skiing-nordic:before{content:"\f7ca"}.fa-skull:before{content:"\f54c"}.fa-skull-crossbones:before{content:"\f714"}.fa-skyatlas:before{content:"\f216"}.fa-skype:before{content:"\f17e"}.fa-slack:before{content:"\f198"}.fa-slack-hash:before{content:"\f3ef"}.fa-slash:before{content:"\f715"}.fa-sleigh:before{content:"\f7cc"}.fa-sliders-h:before{content:"\f1de"}.fa-slideshare:before{content:"\f1e7"}.fa-smile:before{content:"\f118"}.fa-smile-beam:before{content:"\f5b8"}.fa-smile-wink:before{content:"\f4da"}.fa-smog:before{content:"\f75f"}.fa-smoking:before{content:"\f48d"}.fa-smoking-ban:before{content:"\f54d"}.fa-sms:before{content:"\f7cd"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-snowboarding:before{content:"\f7ce"}.fa-snowflake:before{content:"\f2dc"}.fa-snowman:before{content:"\f7d0"}.fa-snowplow:before{content:"\f7d2"}.fa-socks:before{content:"\f696"}.fa-solar-panel:before{content:"\f5ba"}.fa-sort:before{content:"\f0dc"}.fa-sort-alpha-down:before{content:"\f15d"}.fa-sort-alpha-up:before{content:"\f15e"}.fa-sort-amount-down:before{content:"\f160"}.fa-sort-amount-up:before{content:"\f161"}.fa-sort-down:before{content:"\f0dd"}.fa-sort-numeric-down:before{content:"\f162"}.fa-sort-numeric-up:before{content:"\f163"}.fa-sort-up:before{content:"\f0de"}.fa-soundcloud:before{content:"\f1be"}.fa-sourcetree:before{content:"\f7d3"}.fa-spa:before{content:"\f5bb"}.fa-space-shuttle:before{content:"\f197"}.fa-speakap:before{content:"\f3f3"}.fa-spider:before{content:"\f717"}.fa-spinner:before{content:"\f110"}.fa-splotch:before{content:"\f5bc"}.fa-spotify:before{content:"\f1bc"}.fa-spray-can:before{content:"\f5bd"}.fa-square:before{content:"\f0c8"}.fa-square-full:before{content:"\f45c"}.fa-square-root-alt:before{content:"\f698"}.fa-squarespace:before{content:"\f5be"}.fa-stack-exchange:before{content:"\f18d"}.fa-stack-overflow:before{content:"\f16c"}.fa-stamp:before{content:"\f5bf"}.fa-star:before{content:"\f005"}.fa-star-and-crescent:before{content:"\f699"}.fa-star-half:before{content:"\f089"}.fa-star-half-alt:before{content:"\f5c0"}.fa-star-of-david:before{content:"\f69a"}.fa-star-of-life:before{content:"\f621"}.fa-staylinked:before{content:"\f3f5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-steam-symbol:before{content:"\f3f6"}.fa-step-backward:before{content:"\f048"}.fa-step-forward:before{content:"\f051"}.fa-stethoscope:before{content:"\f0f1"}.fa-sticker-mule:before{content:"\f3f7"}.fa-sticky-note:before{content:"\f249"}.fa-stop:before{content:"\f04d"}.fa-stop-circle:before{content:"\f28d"}.fa-stopwatch:before{content:"\f2f2"}.fa-store:before{content:"\f54e"}.fa-store-alt:before{content:"\f54f"}.fa-strava:before{content:"\f428"}.fa-stream:before{content:"\f550"}.fa-street-view:before{content:"\f21d"}.fa-strikethrough:before{content:"\f0cc"}.fa-stripe:before{content:"\f429"}.fa-stripe-s:before{content:"\f42a"}.fa-stroopwafel:before{content:"\f551"}.fa-studiovinari:before{content:"\f3f8"}.fa-stumbleupon:before{content:"\f1a4"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-subscript:before{content:"\f12c"}.fa-subway:before{content:"\f239"}.fa-suitcase:before{content:"\f0f2"}.fa-suitcase-rolling:before{content:"\f5c1"}.fa-sun:before{content:"\f185"}.fa-superpowers:before{content:"\f2dd"}.fa-superscript:before{content:"\f12b"}.fa-supple:before{content:"\f3f9"}.fa-surprise:before{content:"\f5c2"}.fa-suse:before{content:"\f7d6"}.fa-swatchbook:before{content:"\f5c3"}.fa-swimmer:before{content:"\f5c4"}.fa-swimming-pool:before{content:"\f5c5"}.fa-synagogue:before{content:"\f69b"}.fa-sync:before{content:"\f021"}.fa-sync-alt:before{content:"\f2f1"}.fa-syringe:before{content:"\f48e"}.fa-table:before{content:"\f0ce"}.fa-table-tennis:before{content:"\f45d"}.fa-tablet:before{content:"\f10a"}.fa-tablet-alt:before{content:"\f3fa"}.fa-tablets:before{content:"\f490"}.fa-tachometer-alt:before{content:"\f3fd"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-tape:before{content:"\f4db"}.fa-tasks:before{content:"\f0ae"}.fa-taxi:before{content:"\f1ba"}.fa-teamspeak:before{content:"\f4f9"}.fa-teeth:before{content:"\f62e"}.fa-teeth-open:before{content:"\f62f"}.fa-telegram:before{content:"\f2c6"}.fa-telegram-plane:before{content:"\f3fe"}.fa-temperature-high:before{content:"\f769"}.fa-temperature-low:before{content:"\f76b"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-tenge:before{content:"\f7d7"}.fa-terminal:before{content:"\f120"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-th:before{content:"\f00a"}.fa-th-large:before{content:"\f009"}.fa-th-list:before{content:"\f00b"}.fa-the-red-yeti:before{content:"\f69d"}.fa-theater-masks:before{content:"\f630"}.fa-themeco:before{content:"\f5c6"}.fa-themeisle:before{content:"\f2b2"}.fa-thermometer:before{content:"\f491"}.fa-thermometer-empty:before{content:"\f2cb"}.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-think-peaks:before{content:"\f731"}.fa-thumbs-down:before{content:"\f165"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbtack:before{content:"\f08d"}.fa-ticket-alt:before{content:"\f3ff"}.fa-times:before{content:"\f00d"}.fa-times-circle:before{content:"\f057"}.fa-tint:before{content:"\f043"}.fa-tint-slash:before{content:"\f5c7"}.fa-tired:before{content:"\f5c8"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-toilet:before{content:"\f7d8"}.fa-toilet-paper:before{content:"\f71e"}.fa-toolbox:before{content:"\f552"}.fa-tools:before{content:"\f7d9"}.fa-tooth:before{content:"\f5c9"}.fa-torah:before{content:"\f6a0"}.fa-torii-gate:before{content:"\f6a1"}.fa-tractor:before{content:"\f722"}.fa-trade-federation:before{content:"\f513"}.fa-trademark:before{content:"\f25c"}.fa-traffic-light:before{content:"\f637"}.fa-train:before{content:"\f238"}.fa-tram:before{content:"\f7da"}.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-trash:before{content:"\f1f8"}.fa-trash-alt:before{content:"\f2ed"}.fa-tree:before{content:"\f1bb"}.fa-trello:before{content:"\f181"}.fa-tripadvisor:before{content:"\f262"}.fa-trophy:before{content:"\f091"}.fa-truck:before{content:"\f0d1"}.fa-truck-loading:before{content:"\f4de"}.fa-truck-monster:before{content:"\f63b"}.fa-truck-moving:before{content:"\f4df"}.fa-truck-pickup:before{content:"\f63c"}.fa-tshirt:before{content:"\f553"}.fa-tty:before{content:"\f1e4"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-tv:before{content:"\f26c"}.fa-twitch:before{content:"\f1e8"}.fa-twitter:before{content:"\f099"}.fa-twitter-square:before{content:"\f081"}.fa-typo3:before{content:"\f42b"}.fa-uber:before{content:"\f402"}.fa-ubuntu:before{content:"\f7df"}.fa-uikit:before{content:"\f403"}.fa-umbrella:before{content:"\f0e9"}.fa-umbrella-beach:before{content:"\f5ca"}.fa-underline:before{content:"\f0cd"}.fa-undo:before{content:"\f0e2"}.fa-undo-alt:before{content:"\f2ea"}.fa-uniregistry:before{content:"\f404"}.fa-universal-access:before{content:"\f29a"}.fa-university:before{content:"\f19c"}.fa-unlink:before{content:"\f127"}.fa-unlock:before{content:"\f09c"}.fa-unlock-alt:before{content:"\f13e"}.fa-untappd:before{content:"\f405"}.fa-upload:before{content:"\f093"}.fa-ups:before{content:"\f7e0"}.fa-usb:before{content:"\f287"}.fa-user:before{content:"\f007"}.fa-user-alt:before{content:"\f406"}.fa-user-alt-slash:before{content:"\f4fa"}.fa-user-astronaut:before{content:"\f4fb"}.fa-user-check:before{content:"\f4fc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-clock:before{content:"\f4fd"}.fa-user-cog:before{content:"\f4fe"}.fa-user-edit:before{content:"\f4ff"}.fa-user-friends:before{content:"\f500"}.fa-user-graduate:before{content:"\f501"}.fa-user-injured:before{content:"\f728"}.fa-user-lock:before{content:"\f502"}.fa-user-md:before{content:"\f0f0"}.fa-user-minus:before{content:"\f503"}.fa-user-ninja:before{content:"\f504"}.fa-user-plus:before{content:"\f234"}.fa-user-secret:before{content:"\f21b"}.fa-user-shield:before{content:"\f505"}.fa-user-slash:before{content:"\f506"}.fa-user-tag:before{content:"\f507"}.fa-user-tie:before{content:"\f508"}.fa-user-times:before{content:"\f235"}.fa-users:before{content:"\f0c0"}.fa-users-cog:before{content:"\f509"}.fa-usps:before{content:"\f7e1"}.fa-ussunnah:before{content:"\f407"}.fa-utensil-spoon:before{content:"\f2e5"}.fa-utensils:before{content:"\f2e7"}.fa-vaadin:before{content:"\f408"}.fa-vector-square:before{content:"\f5cb"}.fa-venus:before{content:"\f221"}.fa-venus-double:before{content:"\f226"}.fa-venus-mars:before{content:"\f228"}.fa-viacoin:before{content:"\f237"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-vial:before{content:"\f492"}.fa-vials:before{content:"\f493"}.fa-viber:before{content:"\f409"}.fa-video:before{content:"\f03d"}.fa-video-slash:before{content:"\f4e2"}.fa-vihara:before{content:"\f6a7"}.fa-vimeo:before{content:"\f40a"}.fa-vimeo-square:before{content:"\f194"}.fa-vimeo-v:before{content:"\f27d"}.fa-vine:before{content:"\f1ca"}.fa-vk:before{content:"\f189"}.fa-vnv:before{content:"\f40b"}.fa-volleyball-ball:before{content:"\f45f"}.fa-volume-down:before{content:"\f027"}.fa-volume-mute:before{content:"\f6a9"}.fa-volume-off:before{content:"\f026"}.fa-volume-up:before{content:"\f028"}.fa-vote-yea:before{content:"\f772"}.fa-vr-cardboard:before{content:"\f729"}.fa-vuejs:before{content:"\f41f"}.fa-walking:before{content:"\f554"}.fa-wallet:before{content:"\f555"}.fa-warehouse:before{content:"\f494"}.fa-water:before{content:"\f773"}.fa-weebly:before{content:"\f5cc"}.fa-weibo:before{content:"\f18a"}.fa-weight:before{content:"\f496"}.fa-weight-hanging:before{content:"\f5cd"}.fa-weixin:before{content:"\f1d7"}.fa-whatsapp:before{content:"\f232"}.fa-whatsapp-square:before{content:"\f40c"}.fa-wheelchair:before{content:"\f193"}.fa-whmcs:before{content:"\f40d"}.fa-wifi:before{content:"\f1eb"}.fa-wikipedia-w:before{content:"\f266"}.fa-wind:before{content:"\f72e"}.fa-window-close:before{content:"\f410"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-windows:before{content:"\f17a"}.fa-wine-bottle:before{content:"\f72f"}.fa-wine-glass:before{content:"\f4e3"}.fa-wine-glass-alt:before{content:"\f5ce"}.fa-wix:before{content:"\f5cf"}.fa-wizards-of-the-coast:before{content:"\f730"}.fa-wolf-pack-battalion:before{content:"\f514"}.fa-won-sign:before{content:"\f159"}.fa-wordpress:before{content:"\f19a"}.fa-wordpress-simple:before{content:"\f411"}.fa-wpbeginner:before{content:"\f297"}.fa-wpexplorer:before{content:"\f2de"}.fa-wpforms:before{content:"\f298"}.fa-wpressr:before{content:"\f3e4"}.fa-wrench:before{content:"\f0ad"}.fa-x-ray:before{content:"\f497"}.fa-xbox:before{content:"\f412"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-y-combinator:before{content:"\f23b"}.fa-yahoo:before{content:"\f19e"}.fa-yandex:before{content:"\f413"}.fa-yandex-international:before{content:"\f414"}.fa-yarn:before{content:"\f7e3"}.fa-yelp:before{content:"\f1e9"}.fa-yen-sign:before{content:"\f157"}.fa-yin-yang:before{content:"\f6ad"}.fa-yoast:before{content:"\f2b1"}.fa-youtube:before{content:"\f167"}.fa-youtube-square:before{content:"\f431"}.fa-zhihu:before{content:"\f63f"}.sr-only{border:0;clip:rect(0,0,0,0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.sr-only-focusable:active,.sr-only-focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}@font-face{font-family:"Font Awesome 5 Brands";font-style:normal;font-weight:normal;src:url(../webfonts/fa-brands-400.eot);src:url(../webfonts/fa-brands-400.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-brands-400.woff2) format("woff2"),url(../webfonts/fa-brands-400.woff) format("woff"),url(../webfonts/fa-brands-400.ttf) format("truetype"),url(../webfonts/fa-brands-400.svg#fontawesome) format("svg")}.fab{font-family:"Font Awesome 5 Brands"}@font-face{font-family:"Font Awesome 5 Free";font-style:normal;font-weight:400;src:url(../webfonts/fa-regular-400.eot);src:url(../webfonts/fa-regular-400.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-regular-400.woff2) format("woff2"),url(../webfonts/fa-regular-400.woff) format("woff"),url(../webfonts/fa-regular-400.ttf) format("truetype"),url(../webfonts/fa-regular-400.svg#fontawesome) format("svg")}.far{font-weight:400}@font-face{font-family:"Font Awesome 5 Free";font-style:normal;font-weight:900;src:url(../webfonts/fa-solid-900.eot);src:url(../webfonts/fa-solid-900.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-solid-900.woff2) format("woff2"),url(../webfonts/fa-solid-900.woff) format("woff"),url(../webfonts/fa-solid-900.ttf) format("truetype"),url(../webfonts/fa-solid-900.svg#fontawesome) format("svg")}.fa,.far,.fas{font-family:"Font Awesome 5 Free"}.fa,.fas{font-weight:900} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/hugo-theme.css b/documentation/staging/1.2/themes/learn/static/css/hugo-theme.css new file mode 100644 index 000000000..ae1fe79c2 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/hugo-theme.css @@ -0,0 +1,241 @@ +/* Insert here special css for hugo theme, on top of any other imported css */ + + +/* Table of contents */ + +.progress ul { + list-style: none; + margin: 0; + padding: 0 15px; +} + +#TableOfContents { + font-size: 13px !important; + max-height: 85vh; + overflow: auto; + padding: 15px 5px !important; +} + +#TableOfContents > ul > li > a { + font-weight: bold; +} + +body { + font-size: 16px !important; + color: #323232 !important; +} + +#body a.highlight, #body a.highlight:hover, #body a.highlight:focus { + text-decoration: none; + outline: none; + outline: 0; +} +#body a.highlight { + line-height: 1.1; + display: inline-block; +} +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + background-color: #0082a7; /*#CE3B2F*/ + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; +} +#body a.highlight:hover:after, #body a.highlight:focus:after { + width: 100%; +} +.progress { + position:absolute; + background-color: rgba(246, 246, 246, 0.97); + width: auto; + border: thin solid #ECECEC; + display:none; + z-index:200; +} + +#toc-menu { + border-right: thin solid #DAD8D8 !important; + padding-right: 1rem !important; + margin-right: 0.5rem !important; +} + +#sidebar-toggle-span { + border-right: thin solid #DAD8D8 !important; + padding-right: 0.5rem !important; + margin-right: 1rem !important; +} + +.btn { + display: inline-block !important; + padding: 6px 12px !important; + margin-bottom: 0 !important; + font-size: 14px !important; + font-weight: normal !important; + line-height: 1.42857143 !important; + text-align: center !important; + white-space: nowrap !important; + vertical-align: middle !important; + -ms-touch-action: manipulation !important; + touch-action: manipulation !important; + cursor: pointer !important; + -webkit-user-select: none !important; + -moz-user-select: none !important; + -ms-user-select: none !important; + user-select: none !important; + background-image: none !important; + border: 1px solid transparent !important; + border-radius: 4px !important; + -webkit-transition: all 0.15s !important; + -moz-transition: all 0.15s !important; + transition: all 0.15s !important; +} +.btn:focus { + /*outline: thin dotted; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px;*/ + outline: none !important; +} +.btn:hover, +.btn:focus { + color: #2b2b2b !important; + text-decoration: none !important; +} + +.btn-default { + color: #333 !important; + background-color: #fff !important; + border-color: #ccc !important; +} +.btn-default:hover, +.btn-default:focus, +.btn-default:active { + color: #fff !important; + background-color: #9e9e9e !important; + border-color: #9e9e9e !important; +} +.btn-default:active { + background-image: none !important; +} + +/* anchors */ +.anchor { + color: #00bdf3; + font-size: 0.5em; + cursor:pointer; + visibility:hidden; + margin-left: 0.5em; + position: absolute; + margin-top:0.1em; +} + +h2:hover .anchor, h3:hover .anchor, h4:hover .anchor, h5:hover .anchor, h6:hover .anchor { + visibility:visible; +} + +/* Redfines headers style */ + +h2, h3, h4, h5, h6 { + font-weight: 400; + line-height: 1.1; +} + +h1 a, h2 a, h3 a, h4 a, h5 a, h6 a { + font-weight: inherit; +} + +h2 { + font-size: 2.5rem; + line-height: 110% !important; + margin: 2.5rem 0 1.5rem 0; +} + +h3 { + font-size: 2rem; + line-height: 110% !important; + margin: 2rem 0 1rem 0; +} + +h4 { + font-size: 1.5rem; + line-height: 110% !important; + margin: 1.5rem 0 0.75rem 0; +} + +h5 { + font-size: 1rem; + line-height: 110% !important; + margin: 1rem 0 0.2rem 0; +} + +h6 { + font-size: 0.5rem; + line-height: 110% !important; + margin: 0.5rem 0 0.2rem 0; +} + +p { + margin: 1rem 0; +} + +figcaption h4 { + font-weight: 300 !important; + opacity: .85; + font-size: 1em; + text-align: center; + margin-top: -1.5em; +} + +.select-style { + border: 0; + width: 150px; + border-radius: 0px; + overflow: hidden; + display: inline-flex; +} + +.select-style svg { + fill: #ccc; + width: 14px; + height: 14px; + pointer-events: none; + margin: auto; +} + +.select-style svg:hover { + fill: #e6e6e6; +} + +.select-style select { + padding: 0; + width: 130%; + border: none; + box-shadow: none; + background: transparent; + background-image: none; + -webkit-appearance: none; + margin: auto; + margin-left: 0px; + margin-right: -20px; +} + +.select-style select:focus { + outline: none; +} + +.select-style :hover { + cursor: pointer; +} + +@media only all and (max-width: 47.938em) { + #breadcrumbs .links, #top-github-link-text { + display: none; + } +} + +.is-sticky #top-bar { + box-shadow: -1px 2px 5px 1px rgba(0, 0, 0, 0.1); +} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/hybrid.css b/documentation/staging/1.2/themes/learn/static/css/hybrid.css new file mode 100644 index 000000000..29735a189 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/hybrid.css @@ -0,0 +1,102 @@ +/* + +vim-hybrid theme by w0ng (https://github.com/w0ng/vim-hybrid) + +*/ + +/*background color*/ +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #1d1f21; +} + +/*selection color*/ +.hljs::selection, +.hljs span::selection { + background: #373b41; +} + +.hljs::-moz-selection, +.hljs span::-moz-selection { + background: #373b41; +} + +/*foreground color*/ +.hljs { + color: #c5c8c6; +} + +/*color: fg_yellow*/ +.hljs-title, +.hljs-name { + color: #f0c674; +} + +/*color: fg_comment*/ +.hljs-comment, +.hljs-meta, +.hljs-meta .hljs-keyword { + color: #707880; +} + +/*color: fg_red*/ +.hljs-number, +.hljs-symbol, +.hljs-literal, +.hljs-deletion, +.hljs-link { + color: #cc6666 +} + +/*color: fg_green*/ +.hljs-string, +.hljs-doctag, +.hljs-addition, +.hljs-regexp, +.hljs-selector-attr, +.hljs-selector-pseudo { + color: #b5bd68; +} + +/*color: fg_purple*/ +.hljs-attribute, +.hljs-code, +.hljs-selector-id { + color: #b294bb; +} + +/*color: fg_blue*/ +.hljs-keyword, +.hljs-selector-tag, +.hljs-bullet, +.hljs-tag { + color: #81a2be; +} + +/*color: fg_aqua*/ +.hljs-subst, +.hljs-variable, +.hljs-template-tag, +.hljs-template-variable { + color: #8abeb7; +} + +/*color: fg_orange*/ +.hljs-type, +.hljs-built_in, +.hljs-builtin-name, +.hljs-quote, +.hljs-section, +.hljs-selector-class { + color: #de935f; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} diff --git a/documentation/staging/1.2/themes/learn/static/css/nucleus.css b/documentation/staging/1.2/themes/learn/static/css/nucleus.css new file mode 100644 index 000000000..1897fc5d6 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/nucleus.css @@ -0,0 +1,615 @@ +*, *::before, *::after { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; } + +@-webkit-viewport { + width: device-width; } +@-moz-viewport { + width: device-width; } +@-ms-viewport { + width: device-width; } +@-o-viewport { + width: device-width; } +@viewport { + width: device-width; } +html { + font-size: 100%; + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100%; } + +body { + margin: 0; } + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +nav, +section, +summary { + display: block; } + +audio, +canvas, +progress, +video { + display: inline-block; + vertical-align: baseline; } + +audio:not([controls]) { + display: none; + height: 0; } + +[hidden], +template { + display: none; } + +a { + background: transparent; + text-decoration: none; } + +a:active, +a:hover { + outline: 0; } + +abbr[title] { + border-bottom: 1px dotted; } + +b, +strong { + font-weight: bold; } + +dfn { + font-style: italic; } + +mark { + background: #FFFF27; + color: #333; } + +sub, +sup { + font-size: 0.8rem; + line-height: 0; + position: relative; + vertical-align: baseline; } + +sup { + top: -0.5em; } + +sub { + bottom: -0.25em; } + +img { + border: 0; + max-width: 100%; } + +svg:not(:root) { + overflow: hidden; } + +figure { + margin: 1em 40px; } + +hr { + height: 0; } + +pre { + overflow: auto; } + +button, +input, +optgroup, +select, +textarea { + color: inherit; + font: inherit; + margin: 0; } + +button { + overflow: visible; } + +button, +select { + text-transform: none; } + +button, +html input[type="button"], +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; + cursor: pointer; } + +button[disabled], +html input[disabled] { + cursor: default; } + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; } + +input { + line-height: normal; } + +input[type="checkbox"], +input[type="radio"] { + padding: 0; } + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; } + +input[type="search"] { + -webkit-appearance: textfield; } + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; } + +legend { + border: 0; + padding: 0; } + +textarea { + overflow: auto; } + +optgroup { + font-weight: bold; } + +table { + border-collapse: collapse; + border-spacing: 0; + table-layout: fixed; + width: 100%; } + +tr, td, th { + vertical-align: middle; } + +th, td { + padding: 0.425rem 0; } + +th { + text-align: left; } + +.container { + width: 75em; + margin: 0 auto; + padding: 0; } + @media only all and (min-width: 60em) and (max-width: 74.938em) { + .container { + width: 60em; } } + @media only all and (min-width: 48em) and (max-width: 59.938em) { + .container { + width: 48em; } } + @media only all and (min-width: 30.063em) and (max-width: 47.938em) { + .container { + width: 30em; } } + @media only all and (max-width: 30em) { + .container { + width: 100%; } } + +.grid { + display: -webkit-box; + display: -moz-box; + display: box; + display: -webkit-flex; + display: -moz-flex; + display: -ms-flexbox; + display: flex; + -webkit-flex-flow: row; + -moz-flex-flow: row; + flex-flow: row; + list-style: none; + margin: 0; + padding: 0; } + @media only all and (max-width: 47.938em) { + .grid { + -webkit-flex-flow: row wrap; + -moz-flex-flow: row wrap; + flex-flow: row wrap; } } + +.block { + -webkit-box-flex: 1; + -moz-box-flex: 1; + box-flex: 1; + -webkit-flex: 1; + -moz-flex: 1; + -ms-flex: 1; + flex: 1; + min-width: 0; + min-height: 0; } + @media only all and (max-width: 47.938em) { + .block { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 100%; + -moz-flex: 0 100%; + -ms-flex: 0 100%; + flex: 0 100%; } } + +.content { + margin: 0.625rem; + padding: 0.938rem; } + +@media only all and (max-width: 47.938em) { + body [class*="size-"] { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 100%; + -moz-flex: 0 100%; + -ms-flex: 0 100%; + flex: 0 100%; } } + +.size-1-2 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 50%; + -moz-flex: 0 50%; + -ms-flex: 0 50%; + flex: 0 50%; } + +.size-1-3 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 33.33333%; + -moz-flex: 0 33.33333%; + -ms-flex: 0 33.33333%; + flex: 0 33.33333%; } + +.size-1-4 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 25%; + -moz-flex: 0 25%; + -ms-flex: 0 25%; + flex: 0 25%; } + +.size-1-5 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 20%; + -moz-flex: 0 20%; + -ms-flex: 0 20%; + flex: 0 20%; } + +.size-1-6 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 16.66667%; + -moz-flex: 0 16.66667%; + -ms-flex: 0 16.66667%; + flex: 0 16.66667%; } + +.size-1-7 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 14.28571%; + -moz-flex: 0 14.28571%; + -ms-flex: 0 14.28571%; + flex: 0 14.28571%; } + +.size-1-8 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 12.5%; + -moz-flex: 0 12.5%; + -ms-flex: 0 12.5%; + flex: 0 12.5%; } + +.size-1-9 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 11.11111%; + -moz-flex: 0 11.11111%; + -ms-flex: 0 11.11111%; + flex: 0 11.11111%; } + +.size-1-10 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 10%; + -moz-flex: 0 10%; + -ms-flex: 0 10%; + flex: 0 10%; } + +.size-1-11 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 9.09091%; + -moz-flex: 0 9.09091%; + -ms-flex: 0 9.09091%; + flex: 0 9.09091%; } + +.size-1-12 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 8.33333%; + -moz-flex: 0 8.33333%; + -ms-flex: 0 8.33333%; + flex: 0 8.33333%; } + +@media only all and (min-width: 48em) and (max-width: 59.938em) { + .size-tablet-1-2 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 50%; + -moz-flex: 0 50%; + -ms-flex: 0 50%; + flex: 0 50%; } + + .size-tablet-1-3 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 33.33333%; + -moz-flex: 0 33.33333%; + -ms-flex: 0 33.33333%; + flex: 0 33.33333%; } + + .size-tablet-1-4 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 25%; + -moz-flex: 0 25%; + -ms-flex: 0 25%; + flex: 0 25%; } + + .size-tablet-1-5 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 20%; + -moz-flex: 0 20%; + -ms-flex: 0 20%; + flex: 0 20%; } + + .size-tablet-1-6 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 16.66667%; + -moz-flex: 0 16.66667%; + -ms-flex: 0 16.66667%; + flex: 0 16.66667%; } + + .size-tablet-1-7 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 14.28571%; + -moz-flex: 0 14.28571%; + -ms-flex: 0 14.28571%; + flex: 0 14.28571%; } + + .size-tablet-1-8 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 12.5%; + -moz-flex: 0 12.5%; + -ms-flex: 0 12.5%; + flex: 0 12.5%; } + + .size-tablet-1-9 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 11.11111%; + -moz-flex: 0 11.11111%; + -ms-flex: 0 11.11111%; + flex: 0 11.11111%; } + + .size-tablet-1-10 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 10%; + -moz-flex: 0 10%; + -ms-flex: 0 10%; + flex: 0 10%; } + + .size-tablet-1-11 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 9.09091%; + -moz-flex: 0 9.09091%; + -ms-flex: 0 9.09091%; + flex: 0 9.09091%; } + + .size-tablet-1-12 { + -webkit-box-flex: 0; + -moz-box-flex: 0; + box-flex: 0; + -webkit-flex: 0 8.33333%; + -moz-flex: 0 8.33333%; + -ms-flex: 0 8.33333%; + flex: 0 8.33333%; } } +@media only all and (max-width: 47.938em) { + @supports not (flex-wrap: wrap) { + .grid { + display: block; + -webkit-box-lines: inherit; + -moz-box-lines: inherit; + box-lines: inherit; + -webkit-flex-wrap: inherit; + -moz-flex-wrap: inherit; + -ms-flex-wrap: inherit; + flex-wrap: inherit; } + + .block { + display: block; + -webkit-box-flex: inherit; + -moz-box-flex: inherit; + box-flex: inherit; + -webkit-flex: inherit; + -moz-flex: inherit; + -ms-flex: inherit; + flex: inherit; } } } +.first-block { + -webkit-box-ordinal-group: 0; + -webkit-order: -1; + -ms-flex-order: -1; + order: -1; } + +.last-block { + -webkit-box-ordinal-group: 2; + -webkit-order: 1; + -ms-flex-order: 1; + order: 1; } + +.fixed-blocks { + -webkit-flex-flow: row wrap; + -moz-flex-flow: row wrap; + flex-flow: row wrap; } + .fixed-blocks .block { + -webkit-box-flex: inherit; + -moz-box-flex: inherit; + box-flex: inherit; + -webkit-flex: inherit; + -moz-flex: inherit; + -ms-flex: inherit; + flex: inherit; + width: 25%; } + @media only all and (min-width: 60em) and (max-width: 74.938em) { + .fixed-blocks .block { + width: 33.33333%; } } + @media only all and (min-width: 48em) and (max-width: 59.938em) { + .fixed-blocks .block { + width: 50%; } } + @media only all and (max-width: 47.938em) { + .fixed-blocks .block { + width: 100%; } } + +body { + font-size: 1.05rem; + line-height: 1.7; } + +h1, h2, h3, h4, h5, h6 { + margin: 0.85rem 0 1.7rem 0; + text-rendering: optimizeLegibility; } + +h1 { + font-size: 3.25rem; } + +h2 { + font-size: 2.55rem; } + +h3 { + font-size: 2.15rem; } + +h4 { + font-size: 1.8rem; } + +h5 { + font-size: 1.4rem; } + +h6 { + font-size: 0.9rem; } + +p { + margin: 1.7rem 0; } + +ul, ol { + margin-top: 1.7rem; + margin-bottom: 1.7rem; } + ul ul, ul ol, ol ul, ol ol { + margin-top: 0; + margin-bottom: 0; } + +blockquote { + margin: 1.7rem 0; + padding-left: 0.85rem; } + +cite { + display: block; + font-size: 0.925rem; } + cite:before { + content: "\2014 \0020"; } + +pre { + margin: 1.7rem 0; + padding: 0.938rem; } + +code { + vertical-align: bottom; } + +small { + font-size: 0.925rem; } + +hr { + border-left: none; + border-right: none; + border-top: none; + margin: 1.7rem 0; } + +fieldset { + border: 0; + padding: 0.938rem; + margin: 0 0 1.7rem 0; } + +input, +label, +select { + display: block; } + +label { + margin-bottom: 0.425rem; } + label.required:after { + content: "*"; } + label abbr { + display: none; } + +textarea, input[type="email"], input[type="number"], input[type="password"], input[type="search"], input[type="tel"], input[type="text"], input[type="url"], input[type="color"], input[type="date"], input[type="datetime"], input[type="datetime-local"], input[type="month"], input[type="time"], input[type="week"], select[multiple=multiple] { + -webkit-transition: border-color; + -moz-transition: border-color; + transition: border-color; + border-radius: 0.1875rem; + margin-bottom: 0.85rem; + padding: 0.425rem 0.425rem; + width: 100%; } + textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + outline: none; } + +textarea { + resize: vertical; } + +input[type="checkbox"], input[type="radio"] { + display: inline; + margin-right: 0.425rem; } + +input[type="file"] { + width: 100%; } + +select { + width: auto; + max-width: 100%; + margin-bottom: 1.7rem; } + +button, +input[type="submit"] { + cursor: pointer; + user-select: none; + vertical-align: middle; + white-space: nowrap; + border: inherit; } diff --git a/documentation/staging/1.2/themes/learn/static/css/perfect-scrollbar.min.css b/documentation/staging/1.2/themes/learn/static/css/perfect-scrollbar.min.css new file mode 100644 index 000000000..ebd2cb43b --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/perfect-scrollbar.min.css @@ -0,0 +1,2 @@ +/* perfect-scrollbar v0.6.13 */ +.ps-container{-ms-touch-action:auto;touch-action:auto;overflow:hidden !important;-ms-overflow-style:none}@supports (-ms-overflow-style: none){.ps-container{overflow:auto !important}}@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none){.ps-container{overflow:auto !important}}.ps-container.ps-active-x>.ps-scrollbar-x-rail,.ps-container.ps-active-y>.ps-scrollbar-y-rail{display:block;background-color:transparent}.ps-container.ps-in-scrolling.ps-x>.ps-scrollbar-x-rail{background-color:#eee;opacity:.9}.ps-container.ps-in-scrolling.ps-x>.ps-scrollbar-x-rail>.ps-scrollbar-x{background-color:#999;height:11px}.ps-container.ps-in-scrolling.ps-y>.ps-scrollbar-y-rail{background-color:#eee;opacity:.9}.ps-container.ps-in-scrolling.ps-y>.ps-scrollbar-y-rail>.ps-scrollbar-y{background-color:#999;width:11px}.ps-container>.ps-scrollbar-x-rail{display:none;position:absolute;opacity:0;-webkit-transition:background-color .2s linear, opacity .2s linear;-o-transition:background-color .2s linear, opacity .2s linear;-moz-transition:background-color .2s linear, opacity .2s linear;transition:background-color .2s linear, opacity .2s linear;bottom:0px;height:15px}.ps-container>.ps-scrollbar-x-rail>.ps-scrollbar-x{position:absolute;background-color:#aaa;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;-webkit-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, -webkit-border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, -webkit-border-radius .2s ease-in-out;-o-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out;-moz-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out, -moz-border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out, -webkit-border-radius .2s ease-in-out, -moz-border-radius .2s ease-in-out;bottom:2px;height:6px}.ps-container>.ps-scrollbar-x-rail:hover>.ps-scrollbar-x,.ps-container>.ps-scrollbar-x-rail:active>.ps-scrollbar-x{height:11px}.ps-container>.ps-scrollbar-y-rail{display:none;position:absolute;opacity:0;-webkit-transition:background-color .2s linear, opacity .2s linear;-o-transition:background-color .2s linear, opacity .2s linear;-moz-transition:background-color .2s linear, opacity .2s linear;transition:background-color .2s linear, opacity .2s linear;right:0;width:15px}.ps-container>.ps-scrollbar-y-rail>.ps-scrollbar-y{position:absolute;background-color:#aaa;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;-webkit-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, -webkit-border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, -webkit-border-radius .2s ease-in-out;-o-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out;-moz-transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out, -moz-border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out;transition:background-color .2s linear, height .2s linear, width .2s ease-in-out, border-radius .2s ease-in-out, -webkit-border-radius .2s ease-in-out, -moz-border-radius .2s ease-in-out;right:2px;width:6px}.ps-container>.ps-scrollbar-y-rail:hover>.ps-scrollbar-y,.ps-container>.ps-scrollbar-y-rail:active>.ps-scrollbar-y{width:11px}.ps-container:hover.ps-in-scrolling.ps-x>.ps-scrollbar-x-rail{background-color:#eee;opacity:.9}.ps-container:hover.ps-in-scrolling.ps-x>.ps-scrollbar-x-rail>.ps-scrollbar-x{background-color:#999;height:11px}.ps-container:hover.ps-in-scrolling.ps-y>.ps-scrollbar-y-rail{background-color:#eee;opacity:.9}.ps-container:hover.ps-in-scrolling.ps-y>.ps-scrollbar-y-rail>.ps-scrollbar-y{background-color:#999;width:11px}.ps-container:hover>.ps-scrollbar-x-rail,.ps-container:hover>.ps-scrollbar-y-rail{opacity:.6}.ps-container:hover>.ps-scrollbar-x-rail:hover{background-color:#eee;opacity:.9}.ps-container:hover>.ps-scrollbar-x-rail:hover>.ps-scrollbar-x{background-color:#999}.ps-container:hover>.ps-scrollbar-y-rail:hover{background-color:#eee;opacity:.9}.ps-container:hover>.ps-scrollbar-y-rail:hover>.ps-scrollbar-y{background-color:#999} diff --git a/documentation/staging/1.2/themes/learn/static/css/tabs.css b/documentation/staging/1.2/themes/learn/static/css/tabs.css new file mode 100644 index 000000000..2ad272877 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/tabs.css @@ -0,0 +1,43 @@ +#body .tab-nav-button { + border-width: 1px 1px 1px 1px !important; + border-color: #ccc !important; + border-radius: 4px 4px 0 0 !important; + background-color: #ddd !important; + float: left; + display: block; + position: relative; + margin-left: 4px; + bottom: -1px; +} +#body .tab-nav-button:first-child { + margin-left: 0px; +} +#body .tab-nav-button.active { + background-color: #fff !important; + border-bottom-color: #fff !important; +} + +#body .tab-panel { + margin-top: 32px; + margin-bottom: 32px; +} +#body .tab-content { + display: block; + clear: both; + padding: 8px; + border-width: 1px; + border-style: solid; + border-color: #ccc; +} +#body .tab-content .tab-item{ + display: none; +} + +#body .tab-content .tab-item.active{ + display: block; +} + +#body .tab-item pre{ + margin-bottom: 0; + margin-top: 0; +} diff --git a/documentation/staging/1.2/themes/learn/static/css/tags.css b/documentation/staging/1.2/themes/learn/static/css/tags.css new file mode 100644 index 000000000..495d2f9f7 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/tags.css @@ -0,0 +1,49 @@ +/* Tags */ + +#head-tags{ + margin-left:1em; + margin-top:1em; +} + +#body .tags a.tag-link { + display: inline-block; + line-height: 2em; + font-size: 0.8em; + position: relative; + margin: 0 16px 8px 0; + padding: 0 10px 0 12px; + background: #8451a1; + + -webkit-border-bottom-right-radius: 3px; + border-bottom-right-radius: 3px; + -webkit-border-top-right-radius: 3px; + border-top-right-radius: 3px; + + -webkit-box-shadow: 0 1px 2px rgba(0,0,0,0.2); + box-shadow: 0 1px 2px rgba(0,0,0,0.2); + color: #fff; +} + +#body .tags a.tag-link:before { + content: ""; + position: absolute; + top:0; + left: -1em; + width: 0; + height: 0; + border-color: transparent #8451a1 transparent transparent; + border-style: solid; + border-width: 1em 1em 1em 0; +} + +#body .tags a.tag-link:after { + content: ""; + position: absolute; + top: 10px; + left: 1px; + width: 5px; + height: 5px; + -webkit-border-radius: 50%; + border-radius: 100%; + background: #fff; +} diff --git a/documentation/staging/1.2/themes/learn/static/css/theme-blue.css b/documentation/staging/1.2/themes/learn/static/css/theme-blue.css new file mode 100644 index 000000000..1ee1423d0 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/theme-blue.css @@ -0,0 +1,128 @@ + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#1C90F3; /* Color of links */ + --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */ + --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ + + --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ + --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */ + + --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #20272b; /* Color of
    separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} + +#body .tags a.tag-link { + background-color: var(--MENU-HEADER-BG-color); +} + +#body .tags a.tag-link:before { + border-right-color: var(--MENU-HEADER-BG-color); +} + +#homelinks { + background: var(--MENU-HEADER-BG-color); + background-color: var(--MENU-HEADER-BORDER-color); + border-bottom-color: var(--MENU-HEADER-BORDER-color); +} + +#homelinks a { + color: var(--MENU-HOME-LINK-color); +} + +#homelinks a:hover { + color: var(--MENU-HOME-LINK-HOVERED-color); +} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/theme-green.css b/documentation/staging/1.2/themes/learn/static/css/theme-green.css new file mode 100644 index 000000000..c074679aa --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/theme-green.css @@ -0,0 +1,128 @@ + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#599a3e; /* Color of links */ + --MAIN-LINK-HOVER-color:#3f6d2c; /* Color of hovered links */ + --MAIN-ANCHOR-color: #599a3e; /* color of anchors on titles */ + + --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ + --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */ + + --MENU-HEADER-BG-color:#74b559; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#9cd484; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#599a3e; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #84c767; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #c7f7c4; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#1b211c; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#222723; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #599a3e; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #18211c; /* Color of
    separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} + +#body .tags a.tag-link { + background-color: var(--MENU-HEADER-BG-color); +} + +#body .tags a.tag-link:before { + border-right-color: var(--MENU-HEADER-BG-color); +} + +#homelinks { + background: var(--MENU-HEADER-BG-color); + background-color: var(--MENU-HEADER-BORDER-color); + border-bottom-color: var(--MENU-HEADER-BORDER-color); +} + +#homelinks a { + color: var(--MENU-HOME-LINK-color); +} + +#homelinks a:hover { + color: var(--MENU-HOME-LINK-HOVERED-color); +} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/theme-red.css b/documentation/staging/1.2/themes/learn/static/css/theme-red.css new file mode 100644 index 000000000..c5f267424 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/theme-red.css @@ -0,0 +1,128 @@ + +:root{ + + --MAIN-TEXT-color:#323232; /* Color of text by default */ + --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */ + --MAIN-LINK-color:#f31c1c; /* Color of links */ + --MAIN-LINK-HOVER-color:#d01616; /* Color of hovered links */ + --MAIN-ANCHOR-color: #f31c1c; /* color of anchors on titles */ + + --MENU-HOME-LINK-color: #ccc; /* Color of the home button text */ + --MENU-HOME-LINK-HOVER-color: #e6e6e6; /* Color of the hovered home button text */ + + --MENU-HEADER-BG-color:#dc1010; /* Background color of menu header */ + --MENU-HEADER-BORDER-color:#e23131; /*Color of menu header border */ + + --MENU-SEARCH-BG-color:#b90000; /* Search field background color (by default borders + icons) */ + --MENU-SEARCH-BOX-color: #ef2020; /* Override search field border color */ + --MENU-SEARCH-BOX-ICONS-color: #fda1a1; /* Override search field icons color */ + + --MENU-SECTIONS-ACTIVE-BG-color:#2b2020; /* Background color of the active section and its childs */ + --MENU-SECTIONS-BG-color:#312525; /* Background color of other sections */ + --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ + --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ + --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ + --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ + + --MENU-VISITED-color: #ff3333; /* Color of 'page visited' icons in menu */ + --MENU-SECTION-HR-color: #2b2020; /* Color of
    separator in menu */ + +} + +body { + color: var(--MAIN-TEXT-color) !important; +} + +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: none; + box-shadow: none; +} + +h2, h3, h4, h5 { + color: var(--MAIN-TITLES-TEXT-color) !important; +} + +a { + color: var(--MAIN-LINK-color); +} + +.anchor { + color: var(--MAIN-ANCHOR-color); +} + +a:hover { + color: var(--MAIN-LINK-HOVER-color); +} + +#sidebar ul li.visited > a .read-icon { + color: var(--MENU-VISITED-color); +} + +#body a.highlight:after { + display: block; + content: ""; + height: 1px; + width: 0%; + -webkit-transition: width 0.5s ease; + -moz-transition: width 0.5s ease; + -ms-transition: width 0.5s ease; + transition: width 0.5s ease; + background-color: var(--MAIN-LINK-HOVER-color); +} +#sidebar { + background-color: var(--MENU-SECTIONS-BG-color); +} +#sidebar #header-wrapper { + background: var(--MENU-HEADER-BG-color); + color: var(--MENU-SEARCH-BOX-color); + border-color: var(--MENU-HEADER-BORDER-color); +} +#sidebar .searchbox { + border-color: var(--MENU-SEARCH-BOX-color); + background: var(--MENU-SEARCH-BG-color); +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: var(--MENU-SECTIONS-ACTIVE-BG-color); +} +#sidebar .searchbox * { + color: var(--MENU-SEARCH-BOX-ICONS-color); +} + +#sidebar a { + color: var(--MENU-SECTIONS-LINK-color); +} + +#sidebar a:hover { + color: var(--MENU-SECTIONS-LINK-HOVER-color); +} + +#sidebar ul li.active > a { + background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important; +} + +#sidebar hr { + border-color: var(--MENU-SECTION-HR-color); +} + +#body .tags a.tag-link { + background-color: var(--MENU-HEADER-BG-color); +} + +#body .tags a.tag-link:before { + border-right-color: var(--MENU-HEADER-BG-color); +} + +#homelinks { + background: var(--MENU-HEADER-BG-color); + background-color: var(--MENU-HEADER-BORDER-color); + border-bottom-color: var(--MENU-HEADER-BORDER-color); +} + +#homelinks a { + color: var(--MENU-HOME-LINK-color); +} + +#homelinks a:hover { + color: var(--MENU-HOME-LINK-HOVERED-color); +} \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/css/theme.css b/documentation/staging/1.2/themes/learn/static/css/theme.css new file mode 100644 index 000000000..98a558425 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/css/theme.css @@ -0,0 +1,1143 @@ +@charset "UTF-8"; + +/* Tags */ +@import "tags.css"; + +#top-github-link, #body #breadcrumbs { + position: relative; + top: 50%; + -webkit-transform: translateY(-50%); + -moz-transform: translateY(-50%); + -o-transform: translateY(-50%); + -ms-transform: translateY(-50%); + transform: translateY(-50%); +} +.button, .button-secondary { + display: inline-block; + padding: 7px 12px; +} +.button:active, .button-secondary:active { + margin: 2px 0 -2px 0; +} +@font-face { + font-family: 'Novacento Sans Wide'; + src: url("../fonts/Novecentosanswide-UltraLight-webfont.eot"); + src: url("../fonts/Novecentosanswide-UltraLight-webfont.eot?#iefix") format("embedded-opentype"), url("../fonts/Novecentosanswide-UltraLight-webfont.woff2") format("woff2"), url("../fonts/Novecentosanswide-UltraLight-webfont.woff") format("woff"), url("../fonts/Novecentosanswide-UltraLight-webfont.ttf") format("truetype"), url("../fonts/Novecentosanswide-UltraLight-webfont.svg#novecento_sans_wideultralight") format("svg"); + font-style: normal; + font-weight: 200; +} +@font-face { + font-family: 'Work Sans'; + font-style: normal; + font-weight: 300; + src: url("../fonts/Work_Sans_300.eot?#iefix") format("embedded-opentype"), url("../fonts/Work_Sans_300.woff") format("woff"), url("../fonts/Work_Sans_300.woff2") format("woff2"), url("../fonts/Work_Sans_300.svg#WorkSans") format("svg"), url("../fonts/Work_Sans_300.ttf") format("truetype"); +} +@font-face { + font-family: 'Work Sans'; + font-style: normal; + font-weight: 500; + src: url("../fonts/Work_Sans_500.eot?#iefix") format("embedded-opentype"), url("../fonts/Work_Sans_500.woff") format("woff"), url("../fonts/Work_Sans_500.woff2") format("woff2"), url("../fonts/Work_Sans_500.svg#WorkSans") format("svg"), url("../fonts/Work_Sans_500.ttf") format("truetype"); +} +body { + background: #fff; + color: #777; +} +body #chapter h1 { + font-size: 3.5rem; +} +@media only all and (min-width: 48em) and (max-width: 59.938em) { + body #chapter h1 { + font-size: 3rem; + } +} +@media only all and (max-width: 47.938em) { + body #chapter h1 { + font-size: 2rem; + } +} +a { + color: #00bdf3; +} +a:hover { + color: #0082a7; +} +pre { + position: relative; + color: #ffffff; +} +.bg { + background: #fff; + border: 1px solid #eaeaea; +} +b, strong, label, th { + font-weight: 600; +} +.default-animation, #header #logo-svg, #header #logo-svg path, #sidebar, #sidebar ul, #body, #body .padding, #body .nav { + -webkit-transition: all 0.5s ease; + -moz-transition: all 0.5s ease; + transition: all 0.5s ease; +} +#grav-logo { + max-width: 60%; +} +#grav-logo path { + fill: #fff !important; +} +#sidebar { + font-weight: 300 !important; +} +fieldset { + border: 1px solid #ddd; +} +textarea, input[type="email"], input[type="number"], input[type="password"], input[type="search"], input[type="tel"], input[type="text"], input[type="url"], input[type="color"], input[type="date"], input[type="datetime"], input[type="datetime-local"], input[type="month"], input[type="time"], input[type="week"], select[multiple=multiple] { + background-color: white; + border: 1px solid #ddd; + box-shadow: inset 0 1px 3px rgba(0, 0, 0, 0.06); +} +textarea:hover, input[type="email"]:hover, input[type="number"]:hover, input[type="password"]:hover, input[type="search"]:hover, input[type="tel"]:hover, input[type="text"]:hover, input[type="url"]:hover, input[type="color"]:hover, input[type="date"]:hover, input[type="datetime"]:hover, input[type="datetime-local"]:hover, input[type="month"]:hover, input[type="time"]:hover, input[type="week"]:hover, select[multiple=multiple]:hover { + border-color: #c4c4c4; +} +textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus { + border-color: #00bdf3; + box-shadow: inset 0 1px 3px rgba(0,0,0,.06),0 0 5px rgba(0,169,218,.7) +} +#header-wrapper { + background: #8451a1; + color: #fff; + text-align: center; + border-bottom: 4px solid #9c6fb6; + padding: 1rem; +} +#header a { + display: inline-block; +} +#header #logo-svg { + width: 8rem; + height: 2rem; +} +#header #logo-svg path { + fill: #fff; +} +.searchbox { + margin-top: 1rem; + position: relative; + border: 1px solid #915eae; + background: #764890; + border-radius: 4px; +} +.searchbox label { + color: rgba(255, 255, 255, 0.8); + position: absolute; + left: 10px; + top: 3px; +} +.searchbox span { + color: rgba(255, 255, 255, 0.6); + position: absolute; + right: 10px; + top: 3px; + cursor: pointer; +} +.searchbox span:hover { + color: rgba(255, 255, 255, 0.9); +} +.searchbox input { + display: inline-block; + color: #fff; + width: 100%; + height: 30px; + background: transparent; + border: 0; + padding: 0 25px 0 30px; + margin: 0; + font-weight: 300; +} +.searchbox input::-webkit-input-placeholder { + color: rgba(255, 255, 255, 0.6); +} +.searchbox input::-moz-placeholder { + color: rgba(255, 255, 255, 0.6); +} +.searchbox input:-moz-placeholder { + color: rgba(255, 255, 255, 0.6); +} +.searchbox input:-ms-input-placeholder { + color: rgba(255, 255, 255, 0.6); +} +#sidebar-toggle-span { + display: none; +} +@media only all and (max-width: 47.938em) { + #sidebar-toggle-span { + display: inline; + } +} +#sidebar { + background-color: #322A38; + position: fixed; + top: 0; + width: 300px; + bottom: 0; + left: 0; + font-weight: 400; + font-size: 15px; +} +#sidebar a { + color: #ccc; +} +#sidebar a:hover { + color: #e6e6e6; +} +#sidebar a.subtitle { + color: rgba(204, 204, 204, 0.6); +} +#sidebar hr { + border-bottom: 1px solid #2a232f; +} +#sidebar a.padding { + padding: 0 1rem; +} +#sidebar h5 { + margin: 2rem 0 0; + position: relative; + line-height: 2; +} +#sidebar h5 a { + display: block; + margin-left: 0; + margin-right: 0; + padding-left: 1rem; + padding-right: 1rem; +} +#sidebar h5 i { + color: rgba(204, 204, 204, 0.6); + position: absolute; + right: 0.6rem; + top: 0.7rem; + font-size: 80%; +} +#sidebar h5.parent a { + background: #201b24; + color: #d9d9d9 !important; +} +#sidebar h5.active a { + background: #fff; + color: #777 !important; +} +#sidebar h5.active i { + color: #777 !important; +} +#sidebar h5 + ul.topics { + display: none; + margin-top: 0; +} +#sidebar h5.parent + ul.topics, #sidebar h5.active + ul.topics { + display: block; +} +#sidebar ul { + list-style: none; + padding: 0; + margin: 0; +} +#sidebar ul.searched a { + color: #999999; +} +#sidebar ul.searched .search-match a { + color: #e6e6e6; +} +#sidebar ul.searched .search-match a:hover { + color: white; +} +#sidebar ul.topics { + margin: 0 1rem; +} +#sidebar ul.topics.searched ul { + display: block; +} +#sidebar ul.topics ul { + display: none; + padding-bottom: 1rem; +} +#sidebar ul.topics ul ul { + padding-bottom: 0; +} +#sidebar ul.topics li.parent ul, #sidebar ul.topics > li.active ul { + display: block; +} +#sidebar ul.topics > li > a { + line-height: 2rem; + font-size: 1.1rem; +} +#sidebar ul.topics > li > a b { + opacity: 0.5; + font-weight: normal; +} +#sidebar ul.topics > li > a .fa { + margin-top: 9px; +} +#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active { + background: #251f29; + margin-left: -1rem; + margin-right: -1rem; + padding-left: 1rem; + padding-right: 1rem; +} +#sidebar ul li.active > a { + background: #fff; + color: #777 !important; + margin-left: -1rem; + margin-right: -1rem; + padding-left: 1rem; + padding-right: 1rem; +} +#sidebar ul li { + padding: 0; +} +#sidebar ul li.visited + span { + margin-right: 16px; +} +#sidebar ul li a { + display: block; + padding: 2px 0; +} +#sidebar ul li a span { + text-overflow: ellipsis; + overflow: hidden; + white-space: nowrap; + display: block; +} +#sidebar ul li > a { + padding: 4px 0; +} +#sidebar ul li.visited > a .read-icon { + color: #9c6fb6; + display: inline; +} +#sidebar ul li li { + padding-left: 1rem; + text-indent: 0.2rem; +} +#main { + background: #f7f7f7; + margin: 0 0 1.563rem 0; +} +#body { + position: relative; + margin-left: 300px; + min-height: 100%; +} +#body img, #body .video-container { + margin: 3rem auto; + display: block; + text-align: center; +} +#body img.border, #body .video-container.border { + border: 2px solid #e6e6e6 !important; + padding: 2px; +} +#body img.shadow, #body .video-container.shadow { + box-shadow: 0 10px 30px rgba(0, 0, 0, 0.1); +} +#body img.inline { + display: inline !important; + margin: 0 !important; + vertical-align: bottom; +} +#body .bordered { + border: 1px solid #ccc; +} +#body .padding { + padding: 3rem 6rem; +} +@media only all and (max-width: 59.938em) { + #body .padding { + position: static; + padding: 15px 3rem; + } +} +@media only all and (max-width: 47.938em) { + #body .padding { + padding: 5px 1rem; + } +} +#body h1 + hr { + margin-top: -1.7rem; + margin-bottom: 3rem; +} +@media only all and (max-width: 59.938em) { + #body #navigation { + position: static; + margin-right: 0 !important; + width: 100%; + display: table; + } +} +#body .nav { + position: fixed; + top: 0; + bottom: 0; + width: 4rem; + font-size: 50px; + height: 100%; + cursor: pointer; + display: table; + text-align: center; +} +#body .nav > i { + display: table-cell; + vertical-align: middle; + text-align: center; +} +@media only all and (max-width: 59.938em) { + #body .nav { + display: table-cell; + position: static; + top: auto; + width: 50%; + text-align: center; + height: 100px; + line-height: 100px; + padding-top: 0; + } + #body .nav > i { + display: inline-block; + } +} +#body .nav:hover { + background: #F6F6F6; +} +#body .nav.nav-pref { + left: 0; +} +#body .nav.nav-next { + right: 0; +} +#body-inner { + margin-bottom: 5rem; +} +#chapter { + display: flex; + align-items: center; + justify-content: center; + height: 100%; + padding: 2rem 0; +} +#chapter #body-inner { + padding-bottom: 3rem; + max-width: 80%; +} +#chapter h3 { + font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + font-weight: 300; + text-align: center; +} +#chapter h1 { + font-size: 5rem; + border-bottom: 4px solid #F0F2F4; +} +#chapter p { + text-align: center; + font-size: 1.2rem; +} +#footer { + padding: 3rem 1rem; + color: #b3b3b3; + font-size: 13px; +} +#footer p { + margin: 0; +} +body { + font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + font-weight: 300; + line-height: 1.6; + font-size: 18px !important; +} +h2, h3, h4, h5, h6 { + font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + text-rendering: optimizeLegibility; + color: #5e5e5e; + font-weight: 400; + letter-spacing: -1px; +} +h1 { + font-family: "Novacento Sans Wide", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + text-align: center; + text-transform: uppercase; + color: #222; + font-weight: 200; +} +blockquote { + border-left: 10px solid #F0F2F4; +} +blockquote p { + font-size: 1.1rem; + color: #999; +} +blockquote cite { + display: block; + text-align: right; + color: #666; + font-size: 1.2rem; +} +div.notices { + margin: 2rem 0; + position: relative; +} +div.notices p { + padding: 15px; + display: block; + font-size: 1rem; + margin-top: 0rem; + margin-bottom: 0rem; + color: #666; +} +div.notices p:first-child:before { + position: absolute; + top: 2px; + color: #fff; + font-family: "Font Awesome 5 Free"; + font-weight: 900; + content: "\f06a"; + left: 10px; +} +div.notices p:first-child:after { + position: absolute; + top: 2px; + color: #fff; + left: 2rem; +} +div.notices.info p { + border-top: 30px solid #F0B37E; + background: #FFF2DB; +} +div.notices.info p:first-child:after { + content: 'Info'; +} +div.notices.warning p { + border-top: 30px solid rgba(217, 83, 79, 0.8); + background: #FAE2E2; +} +div.notices.warning p:first-child:after { + content: 'Warning'; +} +div.notices.note p { + border-top: 30px solid #6AB0DE; + background: #E7F2FA; +} +div.notices.note p:first-child:after { + content: 'Note'; +} +div.notices.tip p { + border-top: 30px solid rgba(92, 184, 92, 0.8); + background: #E6F9E6; +} +div.notices.tip p:first-child:after { + content: 'Tip'; +} + +/* attachments shortcode */ + +section.attachments { + margin: 2rem 0; + position: relative; +} + +section.attachments label { + font-weight: 400; + padding-left: 0.5em; + padding-top: 0.2em; + padding-bottom: 0.2em; + margin: 0; +} + +section.attachments .attachments-files { + padding: 15px; + display: block; + font-size: 1rem; + margin-top: 0rem; + margin-bottom: 0rem; + color: #666; +} + +section.attachments.orange label { + color: #fff; + background: #F0B37E; +} + +section.attachments.orange .attachments-files { + background: #FFF2DB; +} + +section.attachments.green label { + color: #fff; + background: rgba(92, 184, 92, 0.8); +} + +section.attachments.green .attachments-files { + background: #E6F9E6; +} + +section.attachments.blue label { + color: #fff; + background: #6AB0DE; +} + +section.attachments.blue .attachments-files { + background: #E7F2FA; +} + +section.attachments.grey label { + color: #fff; + background: #505d65; +} + +section.attachments.grey .attachments-files { + background: #f4f4f4; +} + +/* Children shortcode */ + +/* Children shortcode */ +.children p { + font-size: small; + margin-top: 0px; + padding-top: 0px; + margin-bottom: 0px; + padding-bottom: 0px; +} +.children-li p { + font-size: small; + font-style: italic; + +} +.children-h2 p, .children-h3 p { + font-size: small; + margin-top: 0px; + padding-top: 0px; + margin-bottom: 0px; + padding-bottom: 0px; +} +.children h3,.children h2 { + margin-bottom: 0px; + margin-top: 5px; +} + +code, kbd, pre, samp { + font-family: "Consolas", menlo, monospace; + font-size: 92%; +} +code { + border-radius: 2px; + white-space: nowrap; + color: #5e5e5e; + background: #FFF7DD; + border: 1px solid #fbf0cb; + padding: 0px 2px; +} +code + .copy-to-clipboard { + margin-left: -1px; + border-left: 0 !important; + font-size: inherit !important; + vertical-align: middle; + height: 21px; + top: 0; +} +pre { + padding: 1rem; + margin: 2rem 0; + background: #282c34; + border: 0; + border-radius: 2px; + line-height: 1.15; +} +pre code { + color: whitesmoke; + background: inherit; + white-space: inherit; + border: 0; + padding: 0; + margin: 0; + font-size: 15px; +} +hr { + border-bottom: 4px solid #F0F2F4; +} +.page-title { + margin-top: -25px; + padding: 25px; + float: left; + clear: both; + background: #9c6fb6; + color: #fff; +} +#body a.anchor-link { + color: #ccc; +} +#body a.anchor-link:hover { + color: #9c6fb6; +} +#body-inner .tabs-wrapper.ui-theme-badges { + background: #1d1f21; +} +#body-inner .tabs-wrapper.ui-theme-badges .tabs-nav li { + font-size: 0.9rem; + text-transform: uppercase; +} +#body-inner .tabs-wrapper.ui-theme-badges .tabs-nav li a { + background: #35393c; +} +#body-inner .tabs-wrapper.ui-theme-badges .tabs-nav li.current a { + background: #4d5257; +} +#body-inner pre { + white-space: pre-wrap; +} +.tabs-wrapper pre { + margin: 1rem 0; + border: 0; + padding: 0; + background: inherit; +} +table { + border: 1px solid #eaeaea; + table-layout: auto; +} +th { + background: #f7f7f7; + padding: 0.5rem; +} +td { + padding: 0.5rem; + border: 1px solid #eaeaea; +} +.button { + background: #9c6fb6; + color: #fff; + box-shadow: 0 3px 0 #00a5d4; +} +.button:hover { + background: #00a5d4; + box-shadow: 0 3px 0 #008db6; + color: #fff; +} +.button:active { + box-shadow: 0 1px 0 #008db6; +} +.button-secondary { + background: #F8B450; + color: #fff; + box-shadow: 0 3px 0 #f7a733; +} +.button-secondary:hover { + background: #f7a733; + box-shadow: 0 3px 0 #f69b15; + color: #fff; +} +.button-secondary:active { + box-shadow: 0 1px 0 #f69b15; +} +.bullets { + margin: 1.7rem 0; + margin-left: -0.85rem; + margin-right: -0.85rem; + overflow: auto; +} +.bullet { + float: left; + padding: 0 0.85rem; +} +.two-column-bullet { + width: 50%; +} +@media only all and (max-width: 47.938em) { + .two-column-bullet { + width: 100%; + } +} +.three-column-bullet { + width: 33.33333%; +} +@media only all and (max-width: 47.938em) { + .three-column-bullet { + width: 100%; + } +} +.four-column-bullet { + width: 25%; +} +@media only all and (max-width: 47.938em) { + .four-column-bullet { + width: 100%; + } +} +.bullet-icon { + float: left; + background: #9c6fb6; + padding: 0.875rem; + width: 3.5rem; + height: 3.5rem; + border-radius: 50%; + color: #fff; + font-size: 1.75rem; + text-align: center; +} +.bullet-icon-1 { + background: #9c6fb6; +} +.bullet-icon-2 { + background: #00f3d8; +} +.bullet-icon-3 { + background: #e6f300; +} +.bullet-content { + margin-left: 4.55rem; +} +.tooltipped { + position: relative; +} +.tooltipped:after { + position: absolute; + z-index: 1000000; + display: none; + padding: 5px 8px; + font: normal normal 11px/1.5 "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + color: #fff; + text-align: center; + text-decoration: none; + text-shadow: none; + text-transform: none; + letter-spacing: normal; + word-wrap: break-word; + white-space: pre; + pointer-events: none; + content: attr(aria-label); + background: rgba(0, 0, 0, 0.8); + border-radius: 3px; + -webkit-font-smoothing: subpixel-antialiased; +} +.tooltipped:before { + position: absolute; + z-index: 1000001; + display: none; + width: 0; + height: 0; + color: rgba(0, 0, 0, 0.8); + pointer-events: none; + content: ""; + border: 5px solid transparent; +} +.tooltipped:hover:before, .tooltipped:hover:after, .tooltipped:active:before, .tooltipped:active:after, .tooltipped:focus:before, .tooltipped:focus:after { + display: inline-block; + text-decoration: none; +} +.tooltipped-s:after, .tooltipped-se:after, .tooltipped-sw:after { + top: 100%; + right: 50%; + margin-top: 5px; +} +.tooltipped-s:before, .tooltipped-se:before, .tooltipped-sw:before { + top: auto; + right: 50%; + bottom: -5px; + margin-right: -5px; + border-bottom-color: rgba(0, 0, 0, 0.8); +} +.tooltipped-se:after { + right: auto; + left: 50%; + margin-left: -15px; +} +.tooltipped-sw:after { + margin-right: -15px; +} +.tooltipped-n:after, .tooltipped-ne:after, .tooltipped-nw:after { + right: 50%; + bottom: 100%; + margin-bottom: 5px; +} +.tooltipped-n:before, .tooltipped-ne:before, .tooltipped-nw:before { + top: -5px; + right: 50%; + bottom: auto; + margin-right: -5px; + border-top-color: rgba(0, 0, 0, 0.8); +} +.tooltipped-ne:after { + right: auto; + left: 50%; + margin-left: -15px; +} +.tooltipped-nw:after { + margin-right: -15px; +} +.tooltipped-s:after, .tooltipped-n:after { + transform: translateX(50%); +} +.tooltipped-w:after { + right: 100%; + bottom: 50%; + margin-right: 5px; + transform: translateY(50%); +} +.tooltipped-w:before { + top: 50%; + bottom: 50%; + left: -5px; + margin-top: -5px; + border-left-color: rgba(0, 0, 0, 0.8); +} +.tooltipped-e:after { + bottom: 50%; + left: 100%; + margin-left: 5px; + transform: translateY(50%); +} +.tooltipped-e:before { + top: 50%; + right: -5px; + bottom: 50%; + margin-top: -5px; + border-right-color: rgba(0, 0, 0, 0.8); +} +.highlightable { + padding: 1rem 0 1rem; + overflow: auto; + position: relative; +} +.hljs::selection, .hljs span::selection { + background: #b7b7b7; +} +.lightbox-active #body { + overflow: visible; +} +.lightbox-active #body .padding { + overflow: visible; +} +#github-contrib i { + vertical-align: middle; +} +.featherlight img { + margin: 0 !important; +} +.lifecycle #body-inner ul { + list-style: none; + margin: 0; + padding: 2rem 0 0; + position: relative; +} +.lifecycle #body-inner ol { + margin: 1rem 0 1rem 0; + padding: 2rem; + position: relative; +} +.lifecycle #body-inner ol li { + margin-left: 1rem; +} +.lifecycle #body-inner ol strong, .lifecycle #body-inner ol label, .lifecycle #body-inner ol th { + text-decoration: underline; +} +.lifecycle #body-inner ol ol { + margin-left: -1rem; +} +.lifecycle #body-inner h3[class*='level'] { + font-size: 20px; + position: absolute; + margin: 0; + padding: 4px 10px; + right: 0; + z-index: 1000; + color: #fff; + background: #1ABC9C; +} +.lifecycle #body-inner ol h3 { + margin-top: 1rem !important; + right: 2rem !important; +} +.lifecycle #body-inner .level-1 + ol { + background: #f6fefc; + border: 4px solid #1ABC9C; + color: #16A085; +} +.lifecycle #body-inner .level-1 + ol h3 { + background: #2ECC71; +} +.lifecycle #body-inner .level-2 + ol { + background: #f7fdf9; + border: 4px solid #2ECC71; + color: #27AE60; +} +.lifecycle #body-inner .level-2 + ol h3 { + background: #3498DB; +} +.lifecycle #body-inner .level-3 + ol { + background: #f3f9fd; + border: 4px solid #3498DB; + color: #2980B9; +} +.lifecycle #body-inner .level-3 + ol h3 { + background: #34495E; +} +.lifecycle #body-inner .level-4 + ol { + background: #e4eaf0; + border: 4px solid #34495E; + color: #2C3E50; +} +.lifecycle #body-inner .level-4 + ol h3 { + background: #34495E; +} +#top-bar { + background: #F6F6F6; + border-radius: 2px; + padding: 0 1rem; + height: 0; + min-height: 3rem; +} +#top-github-link { + position: relative; + z-index: 1; + float: right; + display: block; +} +#body #breadcrumbs { + height: auto; + margin-bottom: 0; + padding-left: 0; + line-height: 1.4; + overflow: hidden; + white-space: nowrap; + text-overflow: ellipsis; + width: 70%; + display: inline-block; + float: left; +} +#body #breadcrumbs span { + padding: 0 0.1rem; +} +@media only all and (max-width: 59.938em) { + #sidebar { + width: 230px; + } + #body { + margin-left: 230px; + } +} +@media only all and (max-width: 47.938em) { + #sidebar { + width: 230px; + left: -230px; + } + #body { + margin-left: 0; + width: 100%; + } + .sidebar-hidden { + overflow: hidden; + } + .sidebar-hidden #sidebar { + left: 0; + } + .sidebar-hidden #body { + margin-left: 230px; + overflow: hidden; + } + .sidebar-hidden #overlay { + position: absolute; + left: 0; + right: 0; + top: 0; + bottom: 0; + z-index: 10; + background: rgba(255, 255, 255, 0.5); + cursor: pointer; + } +} +.copy-to-clipboard { + background-image: url(../images/clippy.svg); + background-position: 50% 50%; + background-size: 16px 16px; + background-repeat: no-repeat; + width: 27px; + height: 1.45rem; + top: -1px; + display: inline-block; + vertical-align: middle; + position: relative; + color: #5e5e5e; + background-color: #FFF7DD; + margin-left: -.2rem; + cursor: pointer; + border-radius: 0 2px 2px 0; + margin-bottom: 1px; +} +.copy-to-clipboard:hover { + background-color: #E8E2CD; +} +pre .copy-to-clipboard { + position: absolute; + right: 4px; + top: 4px; + background-color: #C1C4C6; + color: #ccc; + border-radius: 2px; +} +pre .copy-to-clipboard:hover { + background-color: #00bdf3; + color: #fff; +} +.parent-element { + -webkit-transform-style: preserve-3d; + -moz-transform-style: preserve-3d; + transform-style: preserve-3d; +} + +#sidebar ul.topics > li > a .read-icon { + margin-top: 9px; +} + +#sidebar ul { + list-style: none; + padding: 0; + margin: 0; +} + +#sidebar #shortcuts li { + padding: 2px 0; + list-style: none; +} + +#sidebar ul li .read-icon { + display: none; + float: right; + font-size: 13px; + min-width: 16px; + margin: 4px 0 0 0; + text-align: right; +} +#sidebar ul li.visited > a .read-icon { + color: #00bdf3; + display: inline; +} + +#sidebar #shortcuts h3 { + font-family: "Novacento Sans Wide", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; + color: white ; + margin-top:1rem; + padding-left: 1rem; +} + +#homelinks { + background-color: #9c6fb6; + color: #fff; + padding: 7px 0; + border-bottom: 4px solid #9c6fb6; +} + +#searchResults { + text-align: left; +} + +option { + color: initial; +} diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.eot b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.eot new file mode 100644 index 000000000..0a705d653 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.svg b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.svg new file mode 100644 index 000000000..36775f074 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.ttf new file mode 100644 index 000000000..4b8a36d24 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.woff b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.woff new file mode 100644 index 000000000..6f39625e5 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Inconsolata.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.eot b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.eot new file mode 100644 index 000000000..9984682fc Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.svg b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.svg new file mode 100644 index 000000000..6fa1a66e3 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.ttf new file mode 100644 index 000000000..8cfb62dd5 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff new file mode 100644 index 000000000..d5c429079 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 new file mode 100644 index 000000000..eefb4a318 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot new file mode 100644 index 000000000..2a26561f9 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg new file mode 100644 index 000000000..c4e903b61 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf new file mode 100644 index 000000000..9ce9c7f99 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff new file mode 100644 index 000000000..381650c98 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 new file mode 100644 index 000000000..7e659549b Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.eot b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.eot new file mode 100644 index 000000000..4052e4f94 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.svg b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.svg new file mode 100644 index 000000000..0ffbd3a84 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.ttf new file mode 100644 index 000000000..68019e1cc Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff new file mode 100644 index 000000000..a1bd9e469 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff2 b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff2 new file mode 100644 index 000000000..20c68a75c Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_200.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.eot b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.eot new file mode 100644 index 000000000..ace799382 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.svg b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.svg new file mode 100644 index 000000000..7d2936783 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.ttf new file mode 100644 index 000000000..35387c235 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff new file mode 100644 index 000000000..8d789eae9 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff2 b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff2 new file mode 100644 index 000000000..f6e216d64 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_300.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.eot b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.eot new file mode 100644 index 000000000..9df692942 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.eot differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.svg b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.svg new file mode 100644 index 000000000..90a91c14c --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.ttf b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.ttf new file mode 100644 index 000000000..5b8cc5342 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.ttf differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff new file mode 100644 index 000000000..df058514f Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff differ diff --git a/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff2 b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff2 new file mode 100644 index 000000000..b06c54df0 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/fonts/Work_Sans_500.woff2 differ diff --git a/documentation/staging/1.2/themes/learn/static/images/clippy.svg b/documentation/staging/1.2/themes/learn/static/images/clippy.svg new file mode 100644 index 000000000..f4551735e --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/images/clippy.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/staging/1.2/themes/learn/static/images/favicon.png b/documentation/staging/1.2/themes/learn/static/images/favicon.png new file mode 100644 index 000000000..df06e35d6 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/images/favicon.png differ diff --git a/documentation/staging/1.2/themes/learn/static/images/gopher-404.jpg b/documentation/staging/1.2/themes/learn/static/images/gopher-404.jpg new file mode 100644 index 000000000..2a5054389 Binary files /dev/null and b/documentation/staging/1.2/themes/learn/static/images/gopher-404.jpg differ diff --git a/documentation/staging/1.2/themes/learn/static/js/auto-complete.js b/documentation/staging/1.2/themes/learn/static/js/auto-complete.js new file mode 100644 index 000000000..0b4605456 --- /dev/null +++ b/documentation/staging/1.2/themes/learn/static/js/auto-complete.js @@ -0,0 +1,3 @@ +// JavaScript autoComplete v1.0.4 +// https://github.com/Pixabay/JavaScript-autoComplete +var autoComplete=function(){function e(e){function t(e,t){return e.classList?e.classList.contains(t):new RegExp("\\b"+t+"\\b").test(e.className)}function o(e,t,o){e.attachEvent?e.attachEvent("on"+t,o):e.addEventListener(t,o)}function s(e,t,o){e.detachEvent?e.detachEvent("on"+t,o):e.removeEventListener(t,o)}function n(e,s,n,l){o(l||document,s,function(o){for(var s,l=o.target||o.srcElement;l&&!(s=t(l,e));)l=l.parentElement;s&&n.call(l,o)})}if(document.querySelector){var l={selector:0,source:0,minChars:3,delay:150,offsetLeft:0,offsetTop:1,cache:1,menuClass:"",renderItem:function(e,t){t=t.replace(/[-\/\\^$*+?.()|[\]{}]/g,"\\$&");var o=new RegExp("("+t.split(" ").join("|")+")","gi");return'
    '+e.replace(o,"$1")+"
    "},onSelect:function(){}};for(var c in e)e.hasOwnProperty(c)&&(l[c]=e[c]);for(var a="object"==typeof l.selector?[l.selector]:document.querySelectorAll(l.selector),u=0;u0?i.sc.scrollTop=n+i.sc.suggestionHeight+s-i.sc.maxHeight:0>n&&(i.sc.scrollTop=n+s)}else i.sc.scrollTop=0},o(window,"resize",i.updateSC),document.body.appendChild(i.sc),n("autocomplete-suggestion","mouseleave",function(){var e=i.sc.querySelector(".autocomplete-suggestion.selected");e&&setTimeout(function(){e.className=e.className.replace("selected","")},20)},i.sc),n("autocomplete-suggestion","mouseover",function(){var e=i.sc.querySelector(".autocomplete-suggestion.selected");e&&(e.className=e.className.replace("selected","")),this.className+=" selected"},i.sc),n("autocomplete-suggestion","mousedown",function(e){if(t(this,"autocomplete-suggestion")){var o=this.getAttribute("data-val");i.value=o,l.onSelect(e,o,this),i.sc.style.display="none"}},i.sc),i.blurHandler=function(){try{var e=document.querySelector(".autocomplete-suggestions:hover")}catch(t){var e=0}e?i!==document.activeElement&&setTimeout(function(){i.focus()},20):(i.last_val=i.value,i.sc.style.display="none",setTimeout(function(){i.sc.style.display="none"},350))},o(i,"blur",i.blurHandler);var r=function(e){var t=i.value;if(i.cache[t]=e,e.length&&t.length>=l.minChars){for(var o="",s=0;st||t>40)&&13!=t&&27!=t){var o=i.value;if(o.length>=l.minChars){if(o!=i.last_val){if(i.last_val=o,clearTimeout(i.timer),l.cache){if(o in i.cache)return void r(i.cache[o]);for(var s=1;s https://github.com/noelboss/featherlight/issues/317 +!function(u){"use strict";if(void 0!==u)if(u.fn.jquery.match(/-ajax/))"console"in window&&window.console.info("Featherlight needs regular jQuery, not the slim version.");else{var r=[],i=function(t){return r=u.grep(r,function(e){return e!==t&&0','
    ','",'
    '+n.loading+"
    ","
    ","
    "].join("")),o="."+n.namespace+"-close"+(n.otherClose?","+n.otherClose:"");return n.$instance=i.clone().addClass(n.variant),n.$instance.on(n.closeTrigger+"."+n.namespace,function(e){if(!e.isDefaultPrevented()){var t=u(e.target);("background"===n.closeOnClick&&t.is("."+n.namespace)||"anywhere"===n.closeOnClick||t.closest(o).length)&&(n.close(e),e.preventDefault())}}),this},getContent:function(){if(!1!==this.persist&&this.$content)return this.$content;var t=this,e=this.constructor.contentFilters,n=function(e){return t.$currentTarget&&t.$currentTarget.attr(e)},r=n(t.targetAttr),i=t.target||r||"",o=e[t.type];if(!o&&i in e&&(o=e[i],i=t.target&&r),i=i||n("href")||"",!o)for(var a in e)t[a]&&(o=e[a],i=t[a]);if(!o){var s=i;if(i=null,u.each(t.contentFilters,function(){return(o=e[this]).test&&(i=o.test(s)),!i&&o.regex&&s.match&&s.match(o.regex)&&(i=s),!i}),!i)return"console"in window&&window.console.error("Featherlight: no content filter found "+(s?' for "'+s+'"':" (no target specified)")),!1}return o.process.call(t,i)},setContent:function(e){return this.$instance.removeClass(this.namespace+"-loading"),this.$instance.toggleClass(this.namespace+"-iframe",e.is("iframe")),this.$instance.find("."+this.namespace+"-inner").not(e).slice(1).remove().end().replaceWith(u.contains(this.$instance[0],e[0])?"":e),this.$content=e.addClass(this.namespace+"-inner"),this},open:function(t){var n=this;if(n.$instance.hide().appendTo(n.root),!(t&&t.isDefaultPrevented()||!1===n.beforeOpen(t))){t&&t.preventDefault();var e=n.getContent();if(e)return r.push(n),s(!0),n.$instance.fadeIn(n.openSpeed),n.beforeContent(t),u.when(e).always(function(e){n.setContent(e),n.afterContent(t)}).then(n.$instance.promise()).done(function(){n.afterOpen(t)})}return n.$instance.detach(),u.Deferred().reject().promise()},close:function(e){var t=this,n=u.Deferred();return!1===t.beforeClose(e)?n.reject():(0===i(t).length&&s(!1),t.$instance.fadeOut(t.closeSpeed,function(){t.$instance.detach(),t.afterClose(e),n.resolve()})),n.promise()},resize:function(e,t){if(e&&t&&(this.$content.css("width","").css("height",""),this.$content.parent().width()');return n.onload=function(){r.naturalWidth=n.width,r.naturalHeight=n.height,t.resolve(r)},n.onerror=function(){t.reject(r)},n.src=e,t.promise()}},html:{regex:/^\s*<[\w!][^<]*>/,process:function(e){return u(e)}},ajax:{regex:/./,process:function(e){var n=u.Deferred(),r=u("
    ").load(e,function(e,t){"error"!==t&&n.resolve(r.contents()),n.fail()});return n.promise()}},iframe:{process:function(e){var t=new u.Deferred,n=u("