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
+9-15
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,10 @@
7
7
8
8
## How it works
9
9
10
-
-[main](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/main) branch contains the source code
11
-
-[gh-pages](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/gh-pages) branch contains the generated website
12
10
- the contents of each page are stored in [yaml](https://yaml.org/) format in [src/content](/src/content)
13
11
- there is a corresponding [pug](https://pugjs.org/) HTML template for each page in [src/pug](/src/pug)
14
12
- uses CSS and icons from the [Bootstrap](https://getbootstrap.com/) framework
15
-
- uses [npm](https://www.npmjs.com/) and [webpack](https://webpack.js.org/) to manage the build and dependencies
13
+
- uses [pnpm](https://pnpm.io/) and [webpack](https://webpack.js.org/) to manage the build and dependencies
16
14
17
15
## Structure
18
16
@@ -27,7 +25,7 @@
27
25
-[src/assets](/src/assets)
28
26
- contains the image and video files
29
27
-[src/scss](/src/scss)
30
-
- import and customize [Bootstrap css](https://getbootstrap.com/docs/5.1/customize/sass/)
28
+
- import and customize [Bootstrap css](https://getbootstrap.com/docs/5.3/customize/sass/)
31
29
-[src/js](/src/js)
32
30
- additional client-side javascript
33
31
-[src/index.js](/src/index.js)
@@ -37,8 +35,7 @@
37
35
38
36
On every commit to the main branch:
39
37
40
-
-[deploy.yml](https://github.com/spatial-model-editor/spatial-model-editor.github.io/actions/workflows/deploy.yml) action builds website & deploys to [gh-pages](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/gh-pages)
41
-
- github pages hosts these files at [spatial-model-editor.github.io](https://spatial-model-editor.github.io/)
38
+
-[deploy.yml](https://github.com/spatial-model-editor/spatial-model-editor.github.io/actions/workflows/deploy.yml) action builds website & deploys to github-pages at [spatial-model-editor.github.io](https://spatial-model-editor.github.io/)
42
39
43
40
## How to edit locally
44
41
@@ -48,16 +45,13 @@ On every commit to the main branch:
48
45
- (optional) install pre-commit to auto-format code
49
46
-`pip install pre-commit`
50
47
-`pre-commit install`
51
-
- install node (ideally v20 to match versions used for deployment)
52
-
- macOS: `brew install node`
53
-
- windows: https://nodejs.org/en/
54
-
- ubuntu: `sudo apt install nodejs npm`
55
-
- linux/macOS tool to manage multiple node versions: https://github.com/nodenv/nodenv
56
-
- (many) more options: https://nodejs.org/en/download/package-manager
0 commit comments