Skip to content

Commit 7fdc492

Browse files
author
Fabian Morón Zirfas
committed
fix(merge conflicts): fixes all merge conflicts and merges develop into master
2 parents 9343d81 + becc835 commit 7fdc492

File tree

174 files changed

+5715
-4966
lines changed

Some content is hidden

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

174 files changed

+5715
-4966
lines changed

.netlify/state.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"siteId": "c081644c-312b-486e-8594-8bb5c3a869ca"
3+
}

.node-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10.15.3

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v10.15.3

.travis.yml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
language: node_js
2+
cache: npm
23
node_js:
3-
- stable
4+
- lts/*
5+
before_install:
6+
- rvm install 2.6.0
7+
8+
install:
9+
- npm ci
10+
- bundle install
11+
12+
script:
13+
- npm t
14+
- npm run build:api-markup
15+
- npm run webpack:prod
16+
- bundle exec jekyll build

.vscode/settings.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
{
2+
<<<<<<< HEAD
3+
=======
4+
"workbench.colorCustomizations": {
5+
"activityBar.background": "#6ca2ee",
6+
"activityBar.foreground": "#15202b",
7+
"activityBar.inactiveForeground": "#15202b99",
8+
"activityBarBadge.background": "#c81761",
9+
"activityBarBadge.foreground": "#e7e7e7",
10+
"titleBar.activeBackground": "#3e85e9",
11+
"titleBar.inactiveBackground": "#3e85e999",
12+
"titleBar.activeForeground": "#e7e7e7",
13+
"titleBar.inactiveForeground": "#e7e7e799",
14+
"statusBar.background": "#3e85e9",
15+
"statusBarItem.hoverBackground": "#6ca2ee",
16+
"statusBar.foreground": "#e7e7e7"
17+
},
18+
"peacock.color": "#3e85e9",
19+
"spellright.language": [
20+
"en",
21+
"de"
22+
],
23+
"spellright.documentTypes": [
24+
"markdown",
25+
"latex",
26+
"plaintext"
27+
]
28+
>>>>>>> develop
229
}

README.md

Lines changed: 78 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,98 @@
11
# Basil.js
22

3-
[![Build Status](https://travis-ci.org/basiljs/basiljs.github.io.svg?branch=master)](https://travis-ci.org/basiljs/basiljs.github.io)
3+
[![Build Status](https://travis-ci.org/basiljs/basiljs.github.io.svg?branch=master)](https://travis-ci.org/basiljs/basiljs.github.io) [![Netlify Status](https://api.netlify.com/api/v1/badges/c081644c-312b-486e-8594-8bb5c3a869ca/deploy-status)](https://app.netlify.com/sites/basiljs2/deploys)
4+
5+
Hosted on:
6+
7+
[![Netlify Badge](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://basiljs2.netlify.com/)
48

59
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/)
10+
## Update Basil API
11+
12+
If there are changes to the API of Basil.js you can update the data on this repo as follows.
13+
14+
```bash
15+
16+
git pull [email protected]:basiljs/basiljs.github.io.git
17+
cd basiljs.github.io
18+
# get all branches
19+
git fetch -a
20+
# get into the develop branch
21+
git checkout -b develop origin/develop
22+
# now make your new branch based on develop
23+
git checkout -b chore/update-docs
24+
# build the new data source for the site
25+
# This will:
26+
27+
# - Pull the Basil.js' branch `develop` with npm from GitHub (eventually this should be the master, not the develop branch).
28+
# - Generate the file `./build-scripts/api/data.json` from `./node_modules/basiljs/basil.js` using [documentation.js](http://documentation.js.org/).
29+
# - Generate the following files for the index.
30+
# + `./_data/categories.json`
31+
# + `./_data/cats-and-subcats.json`
32+
# - Also generate all the files for the subpages of `_source/reference`.
33+
npm run build:api-markup
34+
# After that you can just commit all the changes and push it the repo again. Netlify will take care of the Jekyll build.
35+
# Only add the files you really want to.
36+
# Adding all with `git add .` is acutally not the right way
37+
# use gits interactive mode or some more specific paths then `.`
38+
git add -i
39+
git commit -m "chore: Update Basil.js api to latest state [Add your favorite emoji here]"
40+
# push current HEAD to remote
41+
git push -u origin HEAD
42+
# Now go to the GitHub UI and create your PR
43+
```
644

7-
## Deploy
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/)
846

9-
If there are some changed to the API of Basil.js you can update the data on this repo as follows.
47+
## Development
1048

11-
npm run build
49+
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.
1250

13-
This will:
51+
- Create a new branch based on branch `develop` (see the code above for a how to 👆).
52+
- Do your thing
53+
- Create a pull request against develop
1454

15-
- Pull the branch develop with npm from GitHub.
16-
- Generate the file `./.bin/api/data.json` from `./node_modules/basiljs/basil.js` using [documentation.js](http://documentation.js.org/).
17-
- Generate the following files for the index.
18-
+ `./_data/categories.json`
19-
+ `./_data/cats-and-subcats.json`
20-
- Also generate all the files for the subpages.
55+
Netlify will create a branch and deploy preview for you and you can see your changes online. Every push to your branch will trigger a new build and will be linked on the PR page.
2156

22-
After that you can just commit all the changes and push it the repo again. GitHub pages will take care of the jekyll build.
57+
To develop locally take a look at the steps below. 👇
2358

59+
### Markup + SCSS
2460

25-
## Development
61+
Most of the Jekyll [liquid magic](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) happens in `./_source`.
2662

27-
To build these docs we are using [Node.js](https://nodejs.org/en/) and [Jekyll](https://jekyllrb.com/). You need both of them installed to develop on this.
63+
To develop in this run:
2864

29-
In the `.bin/` folder you have the scripts to generate the files for the reference. The entry point is `index.js`.
65+
```bash
66+
# once
67+
bundle install
68+
bundle update
69+
# whenever you want to work on the markup/content
70+
# (the --limit_posts 1 --incremental flags are needed
71+
# because we have lots of pages and need to speedup the build)
72+
bundle exec jekyll serve --livereload --limit_posts 1 --incremental
73+
```
3074

31-
Most of the jekyll [liquid magic](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) happens in `./index.html`, `_includes/entry-card.html`.
75+
### Javascript
3276

33-
To develop in this run:
77+
To work on the Javasscript of the site you need to run
78+
79+
```bash
80+
# once
81+
# needs npm v5.7 or higer
82+
npm ci
83+
# when you develop on it
84+
# (starts the webpack dev watch build toolchain)
85+
npm run webpack:dev
86+
```
87+
88+
## Recipes
89+
90+
Resize and crop multiple images using [`mogrify`](https://www.imagemagick.org/script/mogrify.php)
91+
92+
```bash
93+
mogrify -resize 320x180^ -gravity Center -extent 320x180 -quality 100 -format png ./*/thumbnail.jpg
3494

35-
bundle install
36-
bundle update
37-
bundle exec jekyll serve --livereload
95+
```
3896

3997
## License
4098

_source/_data/cats-and-subcats.json

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7721,7 +7721,7 @@
77217721
},
77227722
{
77237723
"name": "Vector.dot",
7724-
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`",
7724+
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.",
77257725
"returns": {
77267726
"name": null,
77277727
"description": "The dot product.",
@@ -7733,45 +7733,50 @@
77337733
"subcategory": "Vector",
77347734
"parameters": [
77357735
{
7736-
"name": "v1",
7737-
"description": "The first vector.",
7736+
"name": "v",
7737+
"description": "Either a full vector or an `x` component.",
77387738
"optional": false,
77397739
"type": [
7740-
"Vector"
7740+
"Vector",
7741+
"Number"
77417742
]
77427743
},
77437744
{
7744-
"name": "v2",
7745-
"description": "The second vector.",
7746-
"optional": false,
7745+
"name": "y",
7746+
"description": "The `y` component.",
7747+
"optional": true,
77477748
"type": [
7748-
"Vector"
7749+
"Number"
7750+
]
7751+
},
7752+
{
7753+
"name": "z",
7754+
"description": "The `z` component.",
7755+
"optional": true,
7756+
"type": [
7757+
"Number"
77497758
]
77507759
}
77517760
],
77527761
"kind": "function",
77537762
"tags": [
77547763
{
77557764
"title": "summary",
7756-
"description": "Calculates the dot product of two vectors."
7765+
"description": "Calculates the dot product from this vector to another."
77577766
},
77587767
{
77597768
"title": "description",
7760-
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`"
7761-
},
7762-
{
7763-
"title": "static",
7764-
"description": null
7769+
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector."
77657770
}
77667771
],
77677772
"examples": [],
77687773
"todo": null,
7769-
"summary": "Calculates the dot product of two vectors.",
7770-
"codetitle": "Vector.dot(v1, v2)"
7774+
"summary": "Calculates the dot product from this vector to another.",
7775+
"codetitle": "Vector.dot(v, [y], [z])"
77717776
},
77727777
{
77737778
"name": "Vector.dot",
7774-
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.",
7779+
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`",
77757780
"returns": {
77767781
"name": null,
77777782
"description": "The dot product.",
@@ -7783,46 +7788,41 @@
77837788
"subcategory": "Vector",
77847789
"parameters": [
77857790
{
7786-
"name": "v",
7787-
"description": "Either a full vector or an `x` component.",
7791+
"name": "v1",
7792+
"description": "The first vector.",
77887793
"optional": false,
77897794
"type": [
7790-
"Vector",
7791-
"Number"
7792-
]
7793-
},
7794-
{
7795-
"name": "y",
7796-
"description": "The `y` component.",
7797-
"optional": true,
7798-
"type": [
7799-
"Number"
7795+
"Vector"
78007796
]
78017797
},
78027798
{
7803-
"name": "z",
7804-
"description": "The `z` component.",
7805-
"optional": true,
7799+
"name": "v2",
7800+
"description": "The second vector.",
7801+
"optional": false,
78067802
"type": [
7807-
"Number"
7803+
"Vector"
78087804
]
78097805
}
78107806
],
78117807
"kind": "function",
78127808
"tags": [
78137809
{
78147810
"title": "summary",
7815-
"description": "Calculates the dot product from this vector to another."
7811+
"description": "Calculates the dot product of two vectors."
78167812
},
78177813
{
78187814
"title": "description",
7819-
"description": "Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector."
7815+
"description": "Static function. Calculates the dot product of two vectors. Is meant to be called \"static\" i.e. `Vector.dot(v1, v2);`"
7816+
},
7817+
{
7818+
"title": "static",
7819+
"description": null
78207820
}
78217821
],
78227822
"examples": [],
78237823
"todo": null,
7824-
"summary": "Calculates the dot product from this vector to another.",
7825-
"codetitle": "Vector.dot(v, [y], [z])"
7824+
"summary": "Calculates the dot product of two vectors.",
7825+
"codetitle": "Vector.dot(v1, v2)"
78267826
},
78277827
{
78287828
"name": "Vector.get",

_source/_includes/aside-left.html

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
11
<aside>
2-
<a href="/"><div class="logo" id="logo"></div></a>
3-
<div class="nav-o-meter"><ul class="bars"><li></li><li></li><li></li></ul></div>
2+
<a href="/">
3+
<div class="logo" id="logo"></div>
4+
</a>
5+
<div class="nav-o-meter">
6+
<ul class="bars">
7+
<li></li>
8+
<li></li>
9+
<li></li>
10+
</ul>
11+
</div>
412
<nav class="main-menu">
5-
<ul>
6-
<!--
13+
<ul>
14+
<!--
715
loop all pages
816
exclude all entry layouts
917
include all default and the reference
1018
exclude the root path
1119
-->
1220
{% assign pages = site.pages | sort: 'order' %}
1321
{% for item in pages %}{% if item.layout != 'entry' %}{%if item.layout == 'default' or item.layout == 'reference' %}{% if item.url != '/' %}
14-
<li class="menu-item {% if item.title == page.title %}active{% endif %}"><a href="{{item.url}}" class="textgrow menu-link">{{item.title}}</a></li>
15-
{% endif %}{% endif %}{% endif %}{% endfor %}
22+
<li class="menu-item {% if item.title == page.title %}active{% endif %}"><a href="{{item.url}}"
23+
class="textgrow menu-link">{{item.title}}</a></li>
24+
{% endif %}{% endif %}{% endif %}{% endfor %}
1625

17-
</ul>
18-
<div class="tweet">
19-
<div class="message"></div>
20-
<div class="tweettime"></div>
21-
<div class="twitter-link"><a href="https://twitter.com/basil_js" class="textgrow menu-link">@basil_js</a></div>
22-
</div>
23-
</nav>
24-
<div class="fhnw-logo">
25-
<a href="http://www.fhnw.ch/hgk/ivk"><img src="/assets/images/fhnwlogo.png" alt="FHNW logo and link"></a>
26-
</div>
26+
</ul>
27+
<div class="tweet">
28+
<div class="message"></div>
29+
<div class="tweettime"></div>
30+
<div class="twitter-link"><a href="https://twitter.com/basil_js" class="textgrow menu-link">@basil_js</a></div>
31+
</div>
32+
<div class="fhnw-logo">
33+
<a href="https://www.fhnw.ch/hgk/ivk"><img src="/assets/images/fhnwlogo.png" alt="FHNW logo and link"></a>
34+
</div>
35+
</nav>
2736
</aside>

0 commit comments

Comments
 (0)