Skip to content

Commit db58faa

Browse files
authored
Merge branch 'master' into chore/update-docs
2 parents e8ef043 + 7fdc492 commit db58faa

File tree

164 files changed

+1699
-6874
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+1699
-6874
lines changed

.gitignore

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,73 @@
11
.DS_Store
2+
package-lock.json
3+
node_modules
24
test/report.txt
35

46
# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
5-
67
# Created by https://www.gitignore.io/api/jekyll,node
78
# Edit at https://www.gitignore.io/?templates=jekyll,node
8-
99
### Jekyll ###
1010
_site/
1111
.sass-cache/
1212
.jekyll-cache/
1313
.jekyll-metadata
14-
1514
### Node ###
1615
# Logs
1716
logs
1817
*.log
1918
npm-debug.log*
2019
yarn-debug.log*
2120
yarn-error.log*
22-
2321
# Runtime data
2422
pids
2523
*.pid
2624
*.seed
2725
*.pid.lock
28-
2926
# Directory for instrumented libs generated by jscoverage/JSCover
3027
lib-cov
31-
3228
# Coverage directory used by tools like istanbul
3329
coverage
34-
3530
# nyc test coverage
3631
.nyc_output
37-
3832
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
3933
.grunt
40-
4134
# Bower dependency directory (https://bower.io/)
4235
bower_components
43-
4436
# node-waf configuration
4537
.lock-wscript
46-
4738
# Compiled binary addons (https://nodejs.org/api/addons.html)
4839
build/Release
49-
5040
# Dependency directories
5141
node_modules/
5242
jspm_packages/
53-
5443
# TypeScript v1 declaration files
5544
typings/
56-
5745
# Optional npm cache directory
5846
.npm
59-
6047
# Optional eslint cache
6148
.eslintcache
62-
6349
# Optional REPL history
6450
.node_repl_history
65-
6651
# Output of 'npm pack'
6752
*.tgz
68-
6953
# Yarn Integrity file
7054
.yarn-integrity
71-
7255
# dotenv environment variables file
7356
.env
7457
.env.test
75-
7658
# parcel-bundler cache (https://parceljs.org/)
7759
.cache
78-
7960
# next.js build output
8061
.next
81-
8262
# nuxt.js build output
8363
.nuxt
84-
8564
# vuepress build output
8665
.vuepress/dist
87-
8866
# Serverless directories
8967
.serverless/
90-
9168
# FuseBox cache
9269
.fusebox/
93-
9470
# DynamoDB Local files
9571
.dynamodb/
96-
9772
# End of https://www.gitignore.io/api/jekyll,node
98-
99-
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
100-
73+
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
2+
<<<<<<< HEAD
3+
=======
24
"workbench.colorCustomizations": {
35
"activityBar.background": "#6ca2ee",
46
"activityBar.foreground": "#15202b",
@@ -23,4 +25,5 @@
2325
"latex",
2426
"plaintext"
2527
]
28+
>>>>>>> develop
2629
}

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ git push -u origin HEAD
4242
# Now go to the GitHub UI and create your PR
4343
```
4444

45+
This repo holds the [site/docs for Basil.js](https://basiljs.github.io/). The current state of development (develop branch) can be found here [basiljs2.netlify.com](https://basiljs2.netlify.com/)
46+
4547
## Development
4648

4749
To build these docs we are using [Webpack](https://webpack.js.org/) and [Jekyll](https://jekyllrb.com/). You need both of these to develop on this.

_source/_data/categories.json

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1343,6 +1343,52 @@
13431343
"summary": "Parses (decodes) a string to a JSON object.",
13441344
"codetitle": "JSON.parse(text, [reviver])"
13451345
},
1346+
{
1347+
"name": "contains",
1348+
"description": "Checks wether a string contains a specific string or if an array contains a specific element.",
1349+
"returns": {
1350+
"name": null,
1351+
"description": "Returns either true or false",
1352+
"type": [
1353+
"Boolean"
1354+
]
1355+
},
1356+
"category": "Data",
1357+
"subcategory": "String Functions",
1358+
"parameters": [
1359+
{
1360+
"name": "searchContainer",
1361+
"description": "A string or an array to be checked",
1362+
"optional": false,
1363+
"type": [
1364+
"String"
1365+
]
1366+
},
1367+
{
1368+
"name": "valueToFind",
1369+
"description": "The value to search for",
1370+
"optional": false,
1371+
"type": [
1372+
"String"
1373+
]
1374+
}
1375+
],
1376+
"kind": "function",
1377+
"tags": [
1378+
{
1379+
"title": "summary",
1380+
"description": "Checks wether a string contains a specific string or if an array contains a specific element."
1381+
},
1382+
{
1383+
"title": "description",
1384+
"description": "Checks wether a string contains a specific string or if an array contains a specific element."
1385+
}
1386+
],
1387+
"examples": [],
1388+
"todo": null,
1389+
"summary": "Parses (decodes) a string to a JSON object.",
1390+
"codetitle": "JSON.parse(text, [reviver])"
1391+
},
13461392
{
13471393
"name": "contains",
13481394
"description": "Checks wether a string contains a specific string or if an array contains a specific element.",

_source/_data/cats-and-subcats.json

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7822,7 +7822,7 @@
78227822
},
78237823
{
78247824
"name": "Vector.dot",
7825-
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`",
7825+
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.",
78267826
"returns": {
78277827
"name": null,
78287828
"description": "The dot product.",
@@ -7834,45 +7834,50 @@
78347834
"subcategory": "Vector",
78357835
"parameters": [
78367836
{
7837-
"name": "v1",
7838-
"description": "The first vector.",
7837+
"name": "v",
7838+
"description": "Either a full vector or an `x` component.",
78397839
"optional": false,
78407840
"type": [
7841-
"Vector"
7841+
"Vector",
7842+
"Number"
78427843
]
78437844
},
78447845
{
7845-
"name": "v2",
7846-
"description": "The second vector.",
7847-
"optional": false,
7846+
"name": "y",
7847+
"description": "The `y` component.",
7848+
"optional": true,
78487849
"type": [
7849-
"Vector"
7850+
"Number"
7851+
]
7852+
},
7853+
{
7854+
"name": "z",
7855+
"description": "The `z` component.",
7856+
"optional": true,
7857+
"type": [
7858+
"Number"
78507859
]
78517860
}
78527861
],
78537862
"kind": "function",
78547863
"tags": [
78557864
{
78567865
"title": "summary",
7857-
"description": "Calculates the dot product of two vectors."
7866+
"description": "Calculates the dot product from this vector to another."
78587867
},
78597868
{
78607869
"title": "description",
7861-
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`"
7862-
},
7863-
{
7864-
"title": "static",
7865-
"description": null
7870+
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector."
78667871
}
78677872
],
78687873
"examples": [],
78697874
"todo": null,
7870-
"summary": "Calculates the dot product of two vectors.",
7871-
"codetitle": "Vector.dot(v1, v2)"
7875+
"summary": "Calculates the dot product from this vector to another.",
7876+
"codetitle": "Vector.dot(v, [y], [z])"
78727877
},
78737878
{
78747879
"name": "Vector.dot",
7875-
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.",
7880+
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`",
78767881
"returns": {
78777882
"name": null,
78787883
"description": "The dot product.",
@@ -7884,46 +7889,41 @@
78847889
"subcategory": "Vector",
78857890
"parameters": [
78867891
{
7887-
"name": "v",
7888-
"description": "Either a full vector or an `x` component.",
7892+
"name": "v1",
7893+
"description": "The first vector.",
78897894
"optional": false,
78907895
"type": [
7891-
"Vector",
7892-
"Number"
7893-
]
7894-
},
7895-
{
7896-
"name": "y",
7897-
"description": "The `y` component.",
7898-
"optional": true,
7899-
"type": [
7900-
"Number"
7896+
"Vector"
79017897
]
79027898
},
79037899
{
7904-
"name": "z",
7905-
"description": "The `z` component.",
7906-
"optional": true,
7900+
"name": "v2",
7901+
"description": "The second vector.",
7902+
"optional": false,
79077903
"type": [
7908-
"Number"
7904+
"Vector"
79097905
]
79107906
}
79117907
],
79127908
"kind": "function",
79137909
"tags": [
79147910
{
79157911
"title": "summary",
7916-
"description": "Calculates the dot product from this vector to another."
7912+
"description": "Calculates the dot product of two vectors."
79177913
},
79187914
{
79197915
"title": "description",
7920-
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector."
7916+
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`"
7917+
},
7918+
{
7919+
"title": "static",
7920+
"description": null
79217921
}
79227922
],
79237923
"examples": [],
79247924
"todo": null,
7925-
"summary": "Calculates the dot product from this vector to another.",
7926-
"codetitle": "Vector.dot(v, [y], [z])"
7925+
"summary": "Calculates the dot product of two vectors.",
7926+
"codetitle": "Vector.dot(v1, v2)"
79277927
},
79287928
{
79297929
"name": "Vector.get",

_source/_data/function-list.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"blendMode":true,"color":true,"colorMode":true,"fill":true,"fillTint":true,"gradient":true,"gradientMode":true,"lerpColor":true,"noFill":true,"noStroke":true,"opacity":true,"stroke":true,"strokeTint":true,"swatch":true,"forEach":true,"binary":true,"hex":true,"unbinary":true,"unhex":true,"CSV":true,"HashList":true,"JSON":true,"contains":true,"endsWith":true,"join":true,"nf":true,"nfc":true,"nfp":true,"nfs":true,"split":true,"splitTokens":true,"startsWith":true,"trim":true,"trimWord":true,"isArray":true,"isInteger":true,"isNumber":true,"isString":true,"isText":true,"isURL":true,"clear":true,"close":true,"doc":true,"layer":true,"referencePoint":true,"remove":true,"revert":true,"units":true,"bleeds":true,"canvasMode":true,"guideX":true,"guideY":true,"margins":true,"pasteboard":true,"addPage":true,"applyMasterPage":true,"masterPage":true,"nextPage":true,"page":true,"pageCount":true,"pageNumber":true,"previousPage":true,"removePage":true,"applyObjectStyle":true,"arrange":true,"bounds":true,"duplicate":true,"graphics":true,"group":true,"items":true,"label":true,"labels":true,"linkedTextFrames":true,"nameOnPage":true,"objectStyle":true,"selection":true,"selections":true,"textFrames":true,"ungroup":true,"addToStory":true,"characters":true,"lines":true,"linkTextFrames":true,"paragraphs":true,"placeholder":true,"stories":true,"textStyleRanges":true,"words":true,"delay":true,"frameRate":true,"height":true,"width":true,"VERSION":true,"EPSILON":true,"HALF_PI":true,"KAPPA":true,"PI":true,"QUARTER_PI":true,"SINCOS_LENGTH":true,"TWO_PI":true,"LOREM":true,"inspect":true,"printInfo":true,"projectFolder":true,"property":true,"size":true,"stackArray":true,"image":true,"imageMode":true,"shellExecute":true,"download":true,"file":true,"files":true,"folder":true,"loadJSON":true,"loadString":true,"loadStrings":true,"selectFile":true,"selectFiles":true,"selectFolder":true,"day":true,"hour":true,"millis":true,"millisecond":true,"minute":true,"month":true,"second":true,"timestamp":true,"weekday":true,"year":true,"abs":true,"ceil":true,"constrain":true,"dist":true,"exp":true,"floor":true,"lerp":true,"log":true,"mag":true,"map":true,"max":true,"min":true,"norm":true,"pow":true,"round":true,"sq":true,"sqrt":true,"noise":true,"noiseDetail":true,"noiseSeed":true,"random":true,"randomSeed":true,"acos":true,"asin":true,"atan":true,"atan2":true,"cos":true,"degrees":true,"radians":true,"sin":true,"tan":true,"Vector":true,"print":true,"println":true,"saveJSON":true,"savePDF":true,"savePNG":true,"saveString":true,"saveStrings":true,"ellipseMode":true,"rectMode":true,"strokeWeight":true,"arc":true,"ellipse":true,"line":true,"point":true,"quad":true,"rect":true,"triangle":true,"addPath":true,"beginShape":true,"endShape":true,"vertex":true,"mode":true,"noLoop":true,"applyMatrix":true,"popMatrix":true,"printMatrix":true,"pushMatrix":true,"resetMatrix":true,"rotate":true,"scale":true,"transform":true,"translate":true,"text":true,"textAlign":true,"textFont":true,"textKerning":true,"textLeading":true,"textSize":true,"textTracking":true,"typo":true,"applyCharacterStyle":true,"applyParagraphStyle":true,"characterStyle":true,"paragraphStyle":true}
1+
{"blendMode":true,"color":true,"colorMode":true,"fill":true,"fillTint":true,"gradient":true,"gradientMode":true,"lerpColor":true,"noFill":true,"noStroke":true,"opacity":true,"stroke":true,"strokeTint":true,"swatch":true,"forEach":true,"binary":true,"hex":true,"unbinary":true,"unhex":true,"CSV":true,"HashList":true,"JSON":true,"contains":true,"endsWith":true,"join":true,"nf":true,"nfc":true,"nfp":true,"nfs":true,"split":true,"splitTokens":true,"startsWith":true,"trim":true,"trimWord":true,"isArray":true,"isInteger":true,"isNumber":true,"isString":true,"isText":true,"isURL":true,"clear":true,"close":true,"doc":true,"layer":true,"referencePoint":true,"remove":true,"revert":true,"units":true,"bleeds":true,"canvasMode":true,"guideX":true,"guideY":true,"margins":true,"pasteboard":true,"addPage":true,"applyMasterPage":true,"masterPage":true,"nextPage":true,"page":true,"pageCount":true,"pageNumber":true,"previousPage":true,"removePage":true,"applyObjectStyle":true,"arrange":true,"bounds":true,"duplicate":true,"graphics":true,"group":true,"items":true,"label":true,"labels":true,"linkedTextFrames":true,"nameOnPage":true,"objectStyle":true,"selection":true,"selections":true,"textFrames":true,"ungroup":true,"addToStory":true,"characters":true,"lines":true,"linkTextFrames":true,"paragraphs":true,"placeholder":true,"stories":true,"textStyleRanges":true,"words":true,"delay":true,"frameRate":true,"height":true,"width":true,"VERSION":true,"EPSILON":true,"HALF_PI":true,"KAPPA":true,"PI":true,"QUARTER_PI":true,"SINCOS_LENGTH":true,"TWO_PI":true,"LOREM":true,"inspect":true,"printInfo":true,"projectFolder":true,"property":true,"size":true,"stackArray":true,"image":true,"imageMode":true,"shellExecute":true,"download":true,"file":true,"files":true,"folder":true,"loadJSON":true,"loadString":true,"loadStrings":true,"selectFile":true,"selectFiles":true,"selectFolder":true,"day":true,"hour":true,"millis":true,"millisecond":true,"minute":true,"month":true,"second":true,"timestamp":true,"weekday":true,"year":true,"abs":true,"ceil":true,"constrain":true,"dist":true,"exp":true,"floor":true,"lerp":true,"log":true,"mag":true,"map":true,"max":true,"min":true,"norm":true,"pow":true,"round":true,"sq":true,"sqrt":true,"noise":true,"noiseDetail":true,"noiseSeed":true,"random":true,"randomSeed":true,"acos":true,"asin":true,"atan":true,"atan2":true,"cos":true,"degrees":true,"radians":true,"sin":true,"tan":true,"Vector":true,"print":true,"println":true,"saveJSON":true,"savePDF":true,"savePNG":true,"saveString":true,"saveStrings":true,"ellipseMode":true,"rectMode":true,"strokeWeight":true,"arc":true,"ellipse":true,"line":true,"point":true,"quad":true,"rect":true,"triangle":true,"addPath":true,"beginShape":true,"endShape":true,"vertex":true,"mode":true,"noLoop":true,"applyMatrix":true,"popMatrix":true,"printMatrix":true,"pushMatrix":true,"resetMatrix":true,"rotate":true,"scale":true,"transform":true,"translate":true,"text":true,"textAlign":true,"textFont":true,"textKerning":true,"textLeading":true,"textSize":true,"textTracking":true,"typo":true,"applyCharacterStyle":true,"applyParagraphStyle":true,"characterStyle":true,"paragraphStyle":true}

0 commit comments

Comments
 (0)