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
Copy file name to clipboardExpand all lines: README.md
+27-1Lines changed: 27 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,33 @@
1
1
Basil.js
2
2
========
3
3
4
-
This repo will hold the [site/docs for Basil.js](https://basiljs.github.io/)
4
+
This repo holds the [site/docs for Basil.js](https://basiljs.github.io/)
5
+
6
+
## Deploy
7
+
8
+
If there are some changed to the API of Basil.js you can update the data on this repo as follows.
9
+
10
+
npm run build
11
+
12
+
This will:
13
+
14
+
- Pull the branch develop with npm from GitHub.
15
+
- Generate the file `./.bin/api/data.json` from `./node_modules/basiljs/basil.js` using [documentation.js](http://documentation.js.org/).
16
+
- Generate the following files for the index.
17
+
+`./_data/categories.json`
18
+
+`./_data/cats-and-subcats.json`
19
+
- Also generate all the files for the subpages.
20
+
21
+
After that you can just commit all the changes and push it the repo again. GitHub pages will take care of the jekyll build.
22
+
23
+
24
+
## Development ##
25
+
26
+
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.
27
+
28
+
In the `.bin/` folder you have the scripts to generate the files for jekyll. The entry point is `index.js`.
29
+
30
+
Most of the jekyll [liquid magic](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) happens in `./index.html`, `_includes/entry-card.html`.
0 commit comments