Merge pull request #124 from prjctimg/dev

Fixed broken link in docs
prjctimg · Jan 21, 2024 · a42435f · a42435f
2 parents b69ae07 + a2e2c88
commit a42435f
Show file tree

Hide file tree

Showing 129 changed files with 14,166 additions and 14,167 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 
   <p align='center'>
-    <img alt="logo" title="sine_cos_rotation" src="https://github.com/prjctimg/huetiful/blob/main/.github/logo.png">
+    <img alt="logo" title="sine_cos_rotation" src="./.github/logo.png">
 
   </p>
   <cite>*Image made by Rune.js using sine and cosine rotation with hueshifted colors</cite>
@@ -91,12 +91,12 @@ This project is fully open source! Contributions of any kind are greatly appreci
 
 ### References🔗
 
-[Coloring with code: A programmatic approach by George Francis](https://tympanus.net/codrops/2021/12/07/coloring-with-code-a-programmatic-approach-to-design/)
-[Programming Design Systems: Rune Madsen]()
-[Introducing Adaptive Color Palettes]()
-[Culori API docs](https://culorijs.org/api/)
+- [Coloring with code: A programmatic approach by George Francis](https://tympanus.net/codrops/2021/12/07/coloring-with-code-a-programmatic-approach-to-design/)
+- [Programming Design Systems: Rune Madsen]()
+- [Introducing Adaptive Color Palettes]()
+- [Culori API docs](https://culorijs.org/api/)
 
-<img alt="logo" title="huetiful-js" src="https://github.com/prjctimg/huetiful/blob/main/.github/logo_v1.png">
+<img alt="logo" title="huetiful-js" src="./.github/logo_v1.png">
 
 ##### License
 

diff --git a/docs/classes/colors.Color.html b/docs/classes/colors.Color.html
diff --git a/docs/classes/colors.ColorArray.html b/docs/classes/colors.ColorArray.html
diff --git a/docs/functions/colors.color-1.html b/docs/functions/colors.color-1.html
diff --git a/docs/functions/colors.colors.html b/docs/functions/colors.colors.html
diff --git a/docs/functions/colors.diverging.html b/docs/functions/colors.diverging.html
diff --git a/docs/functions/colors.load.html b/docs/functions/colors.load.html
diff --git a/docs/functions/colors.qualitative.html b/docs/functions/colors.qualitative.html
diff --git a/docs/functions/colors.sequential.html b/docs/functions/colors.sequential.html
diff --git a/docs/functions/colors.tailwindColors.html b/docs/functions/colors.tailwindColors.html
diff --git a/docs/functions/converters.num2rgb.html b/docs/functions/converters.num2rgb.html
diff --git a/docs/functions/converters.rgb2num.html b/docs/functions/converters.rgb2num.html
diff --git a/docs/functions/converters.temp2Color.html b/docs/functions/converters.temp2Color.html
diff --git a/docs/functions/converters.toColorTuple.html b/docs/functions/converters.toColorTuple.html
diff --git a/docs/functions/converters.toHex.html b/docs/functions/converters.toHex.html
diff --git a/docs/functions/converters.ucsConverter.html b/docs/functions/converters.ucsConverter.html
diff --git a/docs/functions/filterBy.filterByContrast.html b/docs/functions/filterBy.filterByContrast.html
diff --git a/docs/functions/filterBy.filterByDistance.html b/docs/functions/filterBy.filterByDistance.html
diff --git a/docs/functions/filterBy.filterByHue.html b/docs/functions/filterBy.filterByHue.html
diff --git a/docs/functions/filterBy.filterByLightness.html b/docs/functions/filterBy.filterByLightness.html
diff --git a/docs/functions/filterBy.filterByLuminance.html b/docs/functions/filterBy.filterByLuminance.html
diff --git a/docs/functions/filterBy.filterBySaturation.html b/docs/functions/filterBy.filterBySaturation.html
diff --git a/docs/functions/generators.discoverPalettes.html b/docs/functions/generators.discoverPalettes.html
diff --git a/docs/functions/generators.earthtone.html b/docs/functions/generators.earthtone.html
diff --git a/docs/functions/generators.hueShift.html b/docs/functions/generators.hueShift.html
diff --git a/docs/functions/generators.interpolateSpline.html b/docs/functions/generators.interpolateSpline.html
diff --git a/docs/functions/generators.interpolator.html b/docs/functions/generators.interpolator.html
diff --git a/docs/functions/generators.pairedScheme.html b/docs/functions/generators.pairedScheme.html
diff --git a/docs/functions/generators.pastel.html b/docs/functions/generators.pastel.html
diff --git a/docs/functions/generators.scheme.html b/docs/functions/generators.scheme.html
diff --git a/docs/functions/helpers.adjustHue.html b/docs/functions/helpers.adjustHue.html
diff --git a/docs/functions/helpers.channelDifference.html b/docs/functions/helpers.channelDifference.html
diff --git a/docs/functions/helpers.checkArg.html b/docs/functions/helpers.checkArg.html
diff --git a/docs/functions/helpers.colorObj.html b/docs/functions/helpers.colorObj.html
diff --git a/docs/functions/helpers.colorObjArr.html b/docs/functions/helpers.colorObjArr.html
diff --git a/docs/functions/helpers.customConcat.html b/docs/functions/helpers.customConcat.html
diff --git a/docs/functions/helpers.customFindKey.html b/docs/functions/helpers.customFindKey.html
diff --git a/docs/functions/helpers.customSort.html b/docs/functions/helpers.customSort.html
diff --git a/docs/functions/helpers.eq.html b/docs/functions/helpers.eq.html
diff --git a/docs/functions/helpers.expressionParser.html b/docs/functions/helpers.expressionParser.html
diff --git a/docs/functions/helpers.filteredArr.html b/docs/functions/helpers.filteredArr.html
diff --git a/docs/functions/helpers.floorCeil.html b/docs/functions/helpers.floorCeil.html
diff --git a/docs/functions/helpers.getModeChannel.html b/docs/functions/helpers.getModeChannel.html
diff --git a/docs/functions/helpers.gt.html b/docs/functions/helpers.gt.html
diff --git a/docs/functions/helpers.gte.html b/docs/functions/helpers.gte.html
diff --git a/docs/functions/helpers.inRange.html b/docs/functions/helpers.inRange.html
diff --git a/docs/functions/helpers.isInteger.html b/docs/functions/helpers.isInteger.html
diff --git a/docs/functions/helpers.lt.html b/docs/functions/helpers.lt.html
diff --git a/docs/functions/helpers.lte.html b/docs/functions/helpers.lte.html
diff --git a/docs/functions/helpers.matchChromaChannel.html b/docs/functions/helpers.matchChromaChannel.html
diff --git a/docs/functions/helpers.matchComparator.html b/docs/functions/helpers.matchComparator.html
diff --git a/docs/functions/helpers.matchDigits.html b/docs/functions/helpers.matchDigits.html
diff --git a/docs/functions/helpers.matchLightnessChannel.html b/docs/functions/helpers.matchLightnessChannel.html
diff --git a/docs/functions/helpers.max.html b/docs/functions/helpers.max.html
diff --git a/docs/functions/helpers.min.html b/docs/functions/helpers.min.html
diff --git a/docs/functions/helpers.neq.html b/docs/functions/helpers.neq.html
diff --git a/docs/functions/helpers.normalize.html b/docs/functions/helpers.normalize.html
diff --git a/docs/functions/helpers.random.html b/docs/functions/helpers.random.html
diff --git a/docs/functions/helpers.sortedArr.html b/docs/functions/helpers.sortedArr.html
diff --git a/docs/functions/sortBy.sortByContrast.html b/docs/functions/sortBy.sortByContrast.html
diff --git a/docs/functions/sortBy.sortByDistance.html b/docs/functions/sortBy.sortByDistance.html
diff --git a/docs/functions/sortBy.sortByHue.html b/docs/functions/sortBy.sortByHue.html
diff --git a/docs/functions/sortBy.sortByLightness.html b/docs/functions/sortBy.sortByLightness.html
diff --git a/docs/functions/sortBy.sortByLuminance.html b/docs/functions/sortBy.sortByLuminance.html
diff --git a/docs/functions/sortBy.sortBySaturation.html b/docs/functions/sortBy.sortBySaturation.html
diff --git a/docs/functions/utils.alpha.html b/docs/functions/utils.alpha.html
diff --git a/docs/functions/utils.brighten.html b/docs/functions/utils.brighten.html
diff --git a/docs/functions/utils.colorDeficiency.html b/docs/functions/utils.colorDeficiency.html
diff --git a/docs/functions/utils.darken.html b/docs/functions/utils.darken.html
diff --git a/docs/functions/utils.getChannel.html b/docs/functions/utils.getChannel.html
diff --git a/docs/functions/utils.getComplimentaryHue.html b/docs/functions/utils.getComplimentaryHue.html
diff --git a/docs/functions/utils.getContrast.html b/docs/functions/utils.getContrast.html
diff --git a/docs/functions/utils.getFarthestChroma.html b/docs/functions/utils.getFarthestChroma.html
diff --git a/docs/functions/utils.getFarthestContrast.html b/docs/functions/utils.getFarthestContrast.html
diff --git a/docs/functions/utils.getFarthestHue.html b/docs/functions/utils.getFarthestHue.html
diff --git a/docs/functions/utils.getFarthestLightness.html b/docs/functions/utils.getFarthestLightness.html
diff --git a/docs/functions/utils.getHueFamily.html b/docs/functions/utils.getHueFamily.html
diff --git a/docs/functions/utils.getLuminance.html b/docs/functions/utils.getLuminance.html
diff --git a/docs/functions/utils.getNearestChroma.html b/docs/functions/utils.getNearestChroma.html
diff --git a/docs/functions/utils.getNearestColor.html b/docs/functions/utils.getNearestColor.html
diff --git a/docs/functions/utils.getNearestContrast.html b/docs/functions/utils.getNearestContrast.html
diff --git a/docs/functions/utils.getNearestHue.html b/docs/functions/utils.getNearestHue.html
diff --git a/docs/functions/utils.getNearestLightness.html b/docs/functions/utils.getNearestLightness.html
diff --git a/docs/functions/utils.isAchromatic.html b/docs/functions/utils.isAchromatic.html
diff --git a/docs/functions/utils.isCool.html b/docs/functions/utils.isCool.html
diff --git a/docs/functions/utils.isWarm.html b/docs/functions/utils.isWarm.html
diff --git a/docs/functions/utils.overtone.html b/docs/functions/utils.overtone.html
diff --git a/docs/functions/utils.setChannel.html b/docs/functions/utils.setChannel.html
diff --git a/docs/functions/utils.setLuminance.html b/docs/functions/utils.setLuminance.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/logo.png b/docs/logo.png
diff --git a/docs/logo_v1.png b/docs/logo_v1.png
diff --git a/docs/modules/colors.html b/docs/modules/colors.html
diff --git a/docs/modules/converters.html b/docs/modules/converters.html
diff --git a/docs/modules/filterBy.html b/docs/modules/filterBy.html
diff --git a/docs/modules/generators.html b/docs/modules/generators.html
diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html
diff --git a/docs/modules/sortBy.html b/docs/modules/sortBy.html
diff --git a/docs/modules/types.html b/docs/modules/types.html
diff --git a/docs/modules/utils.html b/docs/modules/utils.html
diff --git a/docs/types/types.AdaptivePaletteOptions.html b/docs/types/types.AdaptivePaletteOptions.html
diff --git a/docs/types/types.ColorDistanceOptions.html b/docs/types/types.ColorDistanceOptions.html
diff --git a/docs/types/types.ColorObject.html b/docs/types/types.ColorObject.html
diff --git a/docs/types/types.ColorOptions.html b/docs/types/types.ColorOptions.html
diff --git a/docs/types/types.ColorToken.html b/docs/types/types.ColorToken.html
diff --git a/docs/types/types.ColorTuple.html b/docs/types/types.ColorTuple.html
diff --git a/docs/types/types.Colorspaces.html b/docs/types/types.Colorspaces.html
diff --git a/docs/types/types.DeficiencyType.html b/docs/types/types.DeficiencyType.html
diff --git a/docs/types/types.DivergingScheme.html b/docs/types/types.DivergingScheme.html
diff --git a/docs/types/types.EarthtoneOptions.html b/docs/types/types.EarthtoneOptions.html
diff --git a/docs/types/types.Factor.html b/docs/types/types.Factor.html
diff --git a/docs/types/types.FactorMapper.html b/docs/types/types.FactorMapper.html
diff --git a/docs/types/types.HueColorSpaces.html b/docs/types/types.HueColorSpaces.html
diff --git a/docs/types/types.HueFamily.html b/docs/types/types.HueFamily.html
diff --git a/docs/types/types.HueShiftOptions.html b/docs/types/types.HueShiftOptions.html
diff --git a/docs/types/types.Interpolator.html b/docs/types/types.Interpolator.html
diff --git a/docs/types/types.InterpolatorOptions.html b/docs/types/types.InterpolatorOptions.html
diff --git a/docs/types/types.Options.html b/docs/types/types.Options.html
diff --git a/docs/types/types.Order.html b/docs/types/types.Order.html
diff --git a/docs/types/types.PairedSchemeOptions.html b/docs/types/types.PairedSchemeOptions.html
diff --git a/docs/types/types.QualitativeScheme.html b/docs/types/types.QualitativeScheme.html
diff --git a/docs/types/types.ScaleValues.html b/docs/types/types.ScaleValues.html
diff --git a/docs/types/types.SequentialScheme.html b/docs/types/types.SequentialScheme.html
diff --git a/docs/types/types.TailwindColorFamilies.html b/docs/types/types.TailwindColorFamilies.html
diff --git a/docs/types/types.Tone.html b/docs/types/types.Tone.html
diff --git a/docs/types/types.UniformColorSpaces.html b/docs/types/types.UniformColorSpaces.html
diff --git a/docs/types/types.callback.html b/docs/types/types.callback.html
diff --git a/docs/variables/helpers.interpolatorConfig.html b/docs/variables/helpers.interpolatorConfig.html
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
   },
   "scripts": {
     "test": "jasmine",
-    "docs": "npx typedoc && git add . && git commit -a -m 'Updated docs'",
+    "docs": "npx typedoc && cp -r ./.github/logo.png ./docs && cp -r ./.github/logo_v1.png ./docs && git add . && git commit -a -m 'Updated docs'",
     "code:build": "node build.cjs",
     "code:prepare": "npm run code:lint & npm run code:format & npm run code:build & npm run code:types & npm run docs",
     "code:types": "dts-bundle-generator -o ./lib/huetiful.d.ts ./src/index.ts",
@@ -89,14 +89,15 @@
     "plugin": [
       "typedoc-material-theme"
     ],
-    "themeColor": "#065f46",
+    "themeColor": "#000000",
     "entryPointStrategy": "resolve",
     "out": "docs",
     "exclude": [
       "./color-maps"
     ],
     "tsconfig": "./tsconfig.json",
-    "disableSources": true
+    "disableSources": false,
+    "gitRemote": "main"
   },
   "files": [
     "lib",
@@ -131,4 +132,4 @@
   "bugs": {
     "url": "https://github.com/prjctimg/huetiful/issues"
   }
-}
+}