theme: Switch to docsy theme

1 files changed, 396 insertions, 0 deletions

diff --git a/themes/docsy/assets/vendor/Font-Awesome/UPGRADING.md b/themes/docsy/assets/vendor/Font-Awesome/UPGRADING.md
new file mode 100644
index 0000000..524b456
--- /dev/null
+++ b/themes/docsy/assets/vendor/Font-Awesome/UPGRADING.md
@@ -0,0 +1,396 @@
+# Upgrading Guide
+
+See the [CHANGELOG.md](./CHANGELOG.md) for detailed information about what has changed between versions.
+
+This guide is useful to figure out what you need to do between breaking changes.
+
+As always, [submit issues](https://github.com/FortAwesome/Font-Awesome/issues/new) that you run into with this guide or with these upgrades to us.
+
+---
+
+## 5.10.0 to 5.10.1
+
+The Sass function `fa-content-secondary` which was part of the `duotone.scss`
+file has been removed due to its inconsistent behavior in different versions of
+Sass pre-processors. Specifically [`node-sass`](https://github.com/sass/node-sass) and
+[`sass`](https://github.com/sass/dart-sass) didn't produce the same output.
+
+---
+
+## 5.9.0 to 5.10.0
+
+The following icon shims have been changed to better match the original version 4 icon:
+
+* sort-alpha-desc
+* sort-amount-desc
+* sort-numeric-desc
+
+---
+
+## 5.8.2 to 5.9.0
+
+The nintendo-switch icon has been removed by legal request of Nintendo of America Inc.
+
+Font Awesome is no longer able to provide icons related to Nintendo, their
+gaming consoles, accessories, or games.
+
+---
+
+## 5.8.1 to 5.8.2
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.8.0 to 5.8.1
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.7.x to 5.8.0
+
+### Removing title elements from SVG sprites
+
+Since the initial release of version 5, all the way back to 5.0.0 actually,
+we've included `<title>` elements in the SVG sprites.
+
+In https://github.com/FortAwesome/Font-Awesome/issues/14595 a discussion
+outlines that this practice actually prevents normal efforts to make these
+sprites accessible according to web accessibility standards.
+
+If you are using sprites please refer to [our documentation on accessibility with Font Awesome](https://fontawesome.com/how-to-use/on-the-web/other-topics/accessibility).
+
+### Removing vertical-align from the .fa-icon Sass mixin
+
+Font Awesome has supported Sass and Less CSS pre-processors for a long time.
+
+The version 5 `.fa-icon` mixin which is present in `scss/_mixins.scss`
+previously included `vertical-align` which was incorrectly shifting icons.
+
+If you have used this mixin in your own Sass files you will need to check the
+alignment of those icons after upgrading to 5.8.0.
+
+---
+
+## 5.7.1 to 5.7.2
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.7.0 to 5.7.1
+
+The cheeseburger icon incorrectly placed the cheese _under_ the patty. This is unacceptable and we've fixed it.
+
+---
+
+## 5.6.x to 5.7.0
+
+### OTF and TTF files
+
+The PostScript name has been changed from `FontAwesome5ProSolid` to `FontAwesome5Pro-Solid`. This was done to be more compatible with tooling such as XCode.
+
+We've also update the `Version` specifier. Font files only support a MAJOR and MINOR version number so we have modifed our schema. For example, version 5.7.0 of Font Awesome is reflected as 329.472 in the individual font files.
+
+### Icon changes
+
+The calendar-alt icon has been reverted back to the previous design in versions <= 5.6.0.
+
+---
+
+## 5.6.x to 5.6.3
+
+The fire icon has been reverted back to the previous design in versions <= 5.5.0.
+
+We have moved the redesigned icon to fire-alt.
+
+---
+
+## 5.6.0 to 5.6.1
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.5.0 to 5.6.0
+
+In this release we've taken time to re-organize the directory structure to
+prevent redundancy and improve findability.
+
+### Directory structure changes
+
+| Old path                          | New path    |
+|-----------------------------------|-------------|
+| advanced-options/metadata         | metadata    |
+| advanced-options/raw-svg          | svgs        |
+| advanced-options/svg-sprites      | sprites     |
+| advanced-options/use-with-node-js | js-packages |
+| svg-with-js/js                    | js          |
+| svg-with-js/css                   | css         |
+| use-on-desktop                    | otfs        |
+| web-fonts-with-css/css            | css         |
+| web-fonts-with-css/less           | less        |
+| web-fonts-with-css/scss           | scss        |
+| web-fonts-with-css/webfonts       | webfonts    |
+
+---
+
+## 5.4.x to 5.5.0
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.4.0 to 5.4.1
+
+Categories were renamed from:
+
+* Holiday to Halloween
+* Seasonal to Autumn
+
+The "wand" icon in version 5.4.0 matched the "wand-magic" icon. The magical
+sparkles have been removed for "wand". If you were relying on this decoration
+in your design switch to "wand-magic" to bring the magic back.
+
+---
+
+## 5.3.x to 5.4.0
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.3.0 to 5.3.1
+
+The following Pro-only icons were removed from Font Awesome Free as of 5.3.1:
+
+* abacus
+* calculator-alt
+* empty-set
+* function
+* integral
+* intersection
+* lambda
+* omega
+* pi
+* sigma
+* signal-alt
+* signal-alt-slash
+* signal-slash
+* square-root
+* tally
+* theta
+* tilde
+* union
+* value-absolute
+* volume
+* volume-down
+* volume-slash
+* wifi-slash
+
+These icons were unintentionally included in 5.3.0.
+
+---
+
+## 5.x.x to 5.3.0
+
+Sass mixin syntax has been updated to address a bug.
+
+Use `@extend %fa-icon` to correctly maintain CSS order in output files.
+
+~~Old way:~~
+
+```
+.twitter {
+  @include fa-icon; /* incorrect */
+  @extend .fab;
+
+  &:before {
+    content: fa-content($fa-var-twitter);
+  }
+}
+```
+
+New way:
+
+```
+.twitter {
+  @extend %fa-icon; /* correct */
+  @extend .fab;
+
+  &:before {
+    content: fa-content($fa-var-twitter);
+  }
+}
+```
+
+---
+
+## 5.1.x to 5.2.x
+
+There are no breaking changes in this version upgrade.
+
+---
+
+## 5.1.0 to 5.1.1
+
+Less and Sass files incorrectly contained the "fa-" prefix for style files.
+These files have been renamed to be consistent with other files in the
+packages.
+
+If you are using the Less or Sass file styles individually you will need to
+correct the names in your builds.
+
+| Old filename                | New filename             |
+| --------------------------- | ------------------------ |
+| less/fa-solid.less          | less/solid.less          |
+| less/fa-regular.less        | less/regular.less        |
+| less/fa-light.less          | less/light.less          |
+| less/fa-brands.less         | less/brands.less         |
+| scss/fa-solid.scss          | scss/solid.scss          |
+| scss/fa-regular.scss        | scss/regular.scss        |
+| scss/fa-light.scss          | scss/light.scss          |
+| scss/fa-brands.scss         | scss/brands.scss         |
+
+---
+
+## 5.0.x to 5.1.0
+
+### New packages available for browser-only integration
+
+**If you were previously using @fortawesome/fontawesome you need to switch to one of the new packages.**
+
+Our Free and Pro CDN provide access to JS, CSS, sprites, and separate SVG files.
+
+We've now made these files conveniently available through NPM.
+
+* [@fortawesome/fontawesome-free](https://www.npmjs.com/package/@fortawesome/fontawesome-free)
+* @fortawesome/fontawesome-pro (private package, requires Pro subscription)
+
+If you are familiar with the paths and options available with the CDN these
+packages should be familiar.
+
+Information about [Font Awesome Pro subscriptions](https://fontawesome.com/pro)
+can be found in your [Font Awesome awesome
+account](https://fontawesome.com/account/services).
+
+### Renamed packages
+
+The following packages have been renamed as part of 5.1.0 of Font Awesome.
+
+_All packages are in the [@fortawesome NPM scope](https://www.npmjs.com/search?q=scope:fortawesome&ranking=optimal)_
+
+| Old package(1)            | New package            |
+|---------------------------|------------------------|
+| fontawesome-free-webfonts | fontawesome-free       |
+| fontawesome-pro-webfonts  | fontawesome-pro        |
+| fontawesome-free-solid    | free-solid-svg-icons   |
+| fontawesome-free-regular  | free-regular-svg-icons |
+| fontawesome-free-brands   | free-brands-svg-icons  |
+| fontawesome-pro-solid     | pro-solid-svg-icons    |
+| fontawesome-pro-regular   | pro-regular-svg-icons  |
+| fontawesome-pro-light     | pro-light-svg-icons    |
+
+(1) Old packages have now been deprecated. They are still available but will only receive high priority patch release fixes.
+
+**You'll need to update your package.json file with the renamed packages and new versions.**
+
+### No more default imports
+
+Recently we spent a good deal of time supporting TypeScript to enable us to
+create the Angular Font Awesome component. During that adventure we
+[were](https://basarat.gitbooks.io/typescript/docs/tips/defaultIsBad.html)
+[convinced](https://blog.neufund.org/why-we-have-banned-default-exports-and-you-should-do-the-same-d51fdc2cf2ad)
+that we were going to remove default exports from all of our components,
+libraries, and packages. This is complete with the umbrella release of `5.1.0` of Font Awesome.
+
+What does that mean?
+
+~~Old way:~~
+
+```javascript
+import fontawesome from '@fortawesome/fontawesome'
+import solid from '@fortawesome/fontawesome-free-solid'
+import faTwitter from '@fortawesome/fontawesome-free-brands/faTwitter'
+import FontAwesomeIcon from '@fortawesome/vue-fontawesome'
+
+library.add(solid, faTwitter)
+```
+
+New way:
+
+```javascript
+import { library, dom } from '@fortawesome/fontawesome-svg-core'
+import { fas } from '@fortawesome/free-solid-svg-icons'
+import { faTwitter } from '@fortawesome/free-brands-svg-icons'
+import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'
+
+library.add(fas, faTwitter)
+
+// Kicks off the process of finding <i> tags and replacing with <svg>
+dom.watch()
+```
+
+This is also a valid way to import icons that works if your tool does not support tree shaking:
+
+```javascript
+import { faTwitter } from '@fortawesome/free-brands-svg-icons/faTwitter'
+```
+
+### Improved support for tree shaking
+
+Tree shaking is now functional by default and no additional configuration is required to make it work.
+
+The `shakable.es.js` module has been removed and is no longer needed.
+
+If you've previously configured tree shaking by modifying your webpack or rollup you can safely remove these.
+
+**We recommend that you check your bundle size after upgrading an ensure that file sizes are as you would expect.**
+
+```javascript
+module.exports = {
+  // ...
+  resolve: {
+    alias: {
+      '@fortawesome/fontawesome-free-solid$': '@fortawesome/fontawesome-free-solid/shakable.es.js'
+    }
+  }
+}
+```
+
+```javascript
+const alias = require('rollup-plugin-alias')
+
+rollup({
+  // ...
+  plugins: [
+    alias({
+      '@fortawesome/fontawesome-free-solid': 'node_modules/@fortawesome/fontawesome-free-solid/shakable.es.js'
+    })
+  ]
+})
+```
+
+---
+
+## 5.0.11 to 5.0.12
+
+Due to a collision with the "r" glyph the R Project brand icon has been renamed to `r-project`.
+
+---
+
+## 5.0.x to 5.0.6
+
+### SVG Attribute was changed from data-fa-processed to data-fa-i2svg
+
+As part of a bug fix for the release of 5.0.6 we renamed an attribute that was found on `<svg>` elements from
+`data-fa-processed` to `data-fa-i2svg`. We feel this more accurately reflects the intent and purpose.
+
+This attribute is added to any icon that has been generated using `fontawesome.dom.i2svg()`.
+
+Be aware that `data-fa-i2svg` (or `data-fa-processed`) will no longer be present on icons that are created using
+`fontawesome.icon()`.
+
+If you've written and DOM queries that rely on `data-fa-processed` you should get things working again by doing a
+simple find and replace.