You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
+
11
+
## Prerequisits
12
+
13
+
- Ruby >= 2.6
14
+
- Ruby Bundler
15
+
- Node.js >= 10
16
+
10
17
## Update Basil API
11
18
12
19
If there are changes to the API of Basil.js you can update the data on this repo as follows.
@@ -55,37 +62,60 @@ To build these docs we are using [Webpack](https://webpack.js.org/) and [Jekyll]
55
62
56
63
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.
57
64
65
+
66
+
58
67
To develop locally take a look at the steps below. 👇
59
68
60
-
### Markup + SCSS
69
+
### Setup
70
+
71
+
```bash
72
+
# Ruby/Jekyll setup
73
+
gem install bundler
74
+
bundle install
75
+
76
+
77
+
# Node Webpack setup
78
+
npm install
79
+
# or
80
+
npm ci
81
+
```
82
+
83
+
### Markup & SCSS & JS
84
+
85
+
To run the full development process you need to run Webpack and Jekyll side by side. They are combined in a script call `dev`.
86
+
87
+
```bash
88
+
npm run dev
89
+
```
90
+
91
+
Your site will be served from [http://0.0.0.0:4000](http://0.0.0.0:4000)
92
+
93
+
### Markup
61
94
62
95
Most of the Jekyll [liquid magic](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) happens in `./_source`.
63
96
64
97
To develop in this run:
65
98
66
99
```bash
67
-
# once
68
-
bundle install
69
-
bundle update
70
100
# whenever you want to work on the markup/content
71
101
# (the --limit_posts 1 --incremental flags are needed
72
102
# because we have lots of pages and need to speedup the build)
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:
102
132
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
103
133
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.
0 commit comments