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
#### After I create a new repository from this template and setup the repo, I get a deployment error. Isn't the website supposed to correctly deploy automatically?
15
4
16
5
Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit. Please make some changes (e.g., change your website info in `_config.yml`), commit, and push. Make sure to follow [deployment instructions](https://github.com/alshedivat/al-folio#deployment). (Relevant issue: [209](https://github.com/alshedivat/al-folio/issues/209#issuecomment-798849211).)
If you are making simple edits and do not need to visualize the changes (locally on your own machine) before making the changes public, go ahead and directly edit the relevant files either directly in [https://github.com/caltech-netlab] or in your local repository and push the changes to github.
20
+
If you are making simple edits and do not need to visualize the changes (locally on your own machine) before making the changes public, you may directly edit the relevant files either directly in [https://github.com/caltech-netlab] or in your local cloned repository and then push the changes to github.
21
21
22
-
## Some references
22
+
If you would like to visualize the changes locally, see [Installing](#installing).
23
23
24
-
Check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/) to learn more about Jekyll. Why Jekyll? Read [Andrej Karpathy's blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/). Some other original references: [INSTALL.md](INSTALL.md), [CUSTOMIZE.md](CUSTOMIZE.md).
24
+
## Modifying site content
25
25
26
-
##Installing
26
+
### Research
27
27
28
-
### Local setup on Windows 10/11
28
+
This Jekyll theme implements `collections` to let you break up your work into categories. The theme comes with two default collections, `news` and `projects`. We only use the `projects` collection to create our research page. The overview of research is edited in the [\_pages/projects.md](_pages/projects.md), and the other four subsections are located in the [\_projects](_projects) folder. The contents of research are written using only HTML.
29
29
30
-
First, install [Git](https://git-scm.com/), [Visual Studio Code](https://code.visualstudio.com/download), and [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). For WSL, choosing the distribution of Ubuntu is fine. You can use any terminal and run the following command:
30
+
Additionally, if you want to create new collections, edit the collections in the [\_config.yml](_config.yml) and create a corresponding folder and a landing page in the [\_pages](_pages) folder.
31
31
32
-
```shell
33
-
bash
32
+
```bash
33
+
$ #adding Links:
34
+
<a href='Link Goes Here'><b>Optimal placement of energy storage in distribution networks</b></a>
35
+
$ #adding Titles:
36
+
<div style="margin-bottom: 12px;"><font size='5.5' id = "applications">Applications</font></div>
<figcaption>Figure 3: An example of a typical charging and discharging curve</figcaption>
42
+
</figure>
43
+
</div>
44
+
$ #adding Bullet Points:
45
+
- content
46
+
```
47
+
---
48
+
49
+
### People
50
+
51
+
You can show each member's short bio and profile picture on the people page. There are three steps. First, add the profile picture in the [assets/img/people/](assets/img/people/) directory. Then, store the short bio in a `.md` file in the [\_pages/descriptions/](_pages/descriptions/) directory. Finally, you can add the member information under the appropriate category in the [\_pages/profiles.md](_pages/profiles.md).
52
+
```bash
53
+
- align: left
54
+
image: faculty/steven-low-canonical.jpg
55
+
content: descriptions/about_steven-low.md (add to descriptions file an md file and route it)
lineBreak: (This is optional and used for styling to make sure everything is aligned) add '<br>' to add one line vertically
34
62
```
63
+
---
64
+
65
+
### Publications
35
66
36
-
to start WSL. Then, install [Node.js](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl), [ImageMagick](https://learnubuntu.com/install-imagemagick/) and [Ruby & Jekyll](https://jekyllrb.com/docs/installation/windows/). After finishing the above installations, you can create a new Jekyll site and make it available on a local server, to determine if it works. Some commands you need can be seen [here](https://jekyllrb.com/docs/). Note that if you encounter any errors during the process, you can find some solutions on Google.
67
+
The publications page is generated automatically from your BibTex bibliography. Simply edit the [\_bibliography/papers.bib](_bibliography/papers.bib). By default, the publications will be sorted by year, with the most recent displayed first. You can change this behavior and more in the `Jekyll Scholar` section in the [\_config.yml](_config.yml). Additionally, if you want to customize the look of the publications page, you can edit the [\_pages/publications.md](_pages/publications.md).
68
+
69
+
You just need to add some specific fields, as shown in the [\_bibliography/papers.bib](_bibliography/papers.bib). More supported fields can be found [here](https://github.com/alshedivat/al-folio).
37
70
38
71
---
39
72
40
-
### Local setup on Mac
73
+
### Presentations
74
+
75
+
The presentations page includes two parts, talks and misc writings, written using only HTML. If you have a new item to add, copy any existing item in [\_pages/presentations.md](_pages/presentations.md) and replace the key information in it.
76
+
77
+
---
78
+
79
+
### Theming
80
+
81
+
A variety of beautiful theme colors have been selected for you to choose from. The default is purple, but you can quickly change it by editing the `--global-theme-color` variable in the `_sass/_themes.scss` file. Other color variables are listed there as well. The stock theme color options available can be found at [\_sass/\_variables.scss](_sass/_variables.scss). You can also add your own colors to this file assigning each a name for ease of use across the template.
82
+
83
+
## Installing
84
+
41
85
#### Local setup using Docker (Recommended)
42
86
43
87
Using Docker to install Jekyll and Ruby dependencies is the easiest way.
@@ -58,65 +102,50 @@ Now, feel free to customize the theme however you like (don't forget to change t
58
102
59
103
> Beta: You can also use the slimmed docker image with a size below 100MBs and exact same functionality. Just use `docker compose up -f docker-compose-slim.yml`
60
104
61
-
#### Build your own docker image
105
+
##Local Setup (Legacy, linux)
62
106
63
-
> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio.
107
+
For Windows, first install [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). For WSL, choosing the distribution of Ubuntu is fine.
64
108
65
-
Build and run a new docker image using:
66
109
67
-
```bash
68
-
$ docker compose up --build
69
-
```
70
-
71
-
> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using `--force-recreate` argument at the end of the previous command! It will download Ruby and Jekyll and install all Ruby packages again from scratch.
72
-
73
-
If you want to use a specific docker version, you can do so by changing `latest` tag to `your_version` in `docker-compose.yaml`. For example, you might have created your website on `v0.10.0` and you want to stick with that.
74
-
75
-
#### Local Setup (Legacy)
110
+
[This blog post](https://george-gca.github.io/blog/2022/running-local-al-folio/) by one of the community members is a helpful guide.
76
111
77
-
For a hands-on walkthrough of running al-folio locally without using Docker, check out [this cool blog post](https://george-gca.github.io/blog/2022/running-local-al-folio/) by one of the community members!
112
+
Install [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) (_hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)_). Install [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (_hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/)_).
78
113
79
-
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (_hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)_), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (_hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/)_).
To see the template running, open your browser and go to `http://localhost:4000`. You should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). Now, feel free to customize the theme however you like. After you are done, remember to **commit** your final changes.
89
125
90
-
---
91
-
92
-
### Git commands
93
126
94
-
When you make some major changes to the website, you can follow these steps:
95
-
96
-
1. Clone the repository to local.
97
-
```
98
-
git clone [url]
99
-
```
100
-
127
+
### Basic Git usage
101
128
102
-
2. Check whether the local repository is up to date before each change.
3. If not, fetch and merge changes to your local directory.
135
+
Before beginning your modification or update, run
108
136
```
109
137
git pull
110
138
```
139
+
which pulls any updates from the remote to your local machine.
111
140
112
-
4. After making changes, push them to the remote repository.
141
+
When you are done making major changes to the website, you can follow these steps:
113
142
```
114
-
git add .
143
+
git add -A
115
144
git commit -m "[Descriptions of your changes]"
116
145
git push -u origin master
117
146
```
118
147
119
-
####Deployment
148
+
## Deployment (Netlify)
120
149
1. Run this once it is working locally the way you would like
121
150
```bash
122
151
$ bundle exec jekyll build --lsi
@@ -144,64 +173,10 @@ $ git push -u origin main
144
173
145
174
7. Push github repo to Netlify following instructions on page
146
175
147
-
## Instructions
148
-
149
-
### Research
150
-
151
-
This Jekyll theme implements `collections` to let you break up your work into categories. The theme comes with two default collections, `news` and `projects`. We only use the `projects` collection to create our research page. The overview of research is edited in the [\_pages/projects.md](_pages/projects.md), and the other four subsections are located in the [\_projects](_projects) folder. The contents of research are written using only HTML.
152
-
153
-
Additionally, if you want to create new collections, edit the collections in the [\_config.yml](_config.yml) and create a corresponding folder and a landing page in the [\_pages](_pages) folder.
154
-
155
-
```bash
156
-
$ #adding Links:
157
-
<a href='Link Goes Here'><b>Optimal placement of energy storage in distribution networks</b></a>
158
-
$ #adding Titles:
159
-
<div style="margin-bottom: 12px;"><font size='5.5' id = "applications">Applications</font></div>
<figcaption>Figure 3: An example of a typical charging and discharging curve</figcaption>
165
-
</figure>
166
-
</div>
167
-
$ #adding Bullet Points:
168
-
- content
169
-
```
170
-
---
171
-
172
-
### People
173
-
174
-
You can show each member's short bio and profile picture on the people page. There are three steps. First, add the profile picture in the [assets/img/people/](assets/img/people/) directory. Then, store the short bio in a `.md` file in the [\_pages/descriptions/](_pages/descriptions/) directory. Finally, you can add the member information under the appropriate category in the [\_pages/profiles.md](_pages/profiles.md).
175
-
```bash
176
-
- align: left
177
-
image: faculty/steven-low-canonical.jpg
178
-
content: descriptions/about_steven-low.md (add to descriptions file an md file and route it)
lineBreak: (This is optional and used for styling to make sure everything is aligned) add '<br>' to add one line vertically
185
-
```
186
-
---
187
-
188
-
### Publications
189
176
190
-
The publications page is generated automatically from your BibTex bibliography. Simply edit the [\_bibliography/papers.bib](_bibliography/papers.bib). By default, the publications will be sorted by year, with the most recent displayed first. You can change this behavior and more in the `Jekyll Scholar` section in the [\_config.yml](_config.yml). Additionally, if you want to customize the look of the publications page, you can edit the [\_pages/publications.md](_pages/publications.md).
191
-
192
-
You just need to add some specific fields, as shown in the [\_bibliography/papers.bib](_bibliography/papers.bib). More supported fields can be found [here](https://github.com/alshedivat/al-folio).
193
-
194
-
---
195
-
196
-
### Presentations
197
-
198
-
The presentations page includes two parts, talks and misc writings, written using only HTML. If you have a new item to add, copy any existing item in [\_pages/presentations.md](_pages/presentations.md) and replace the key information in it.
199
-
200
-
---
201
-
202
-
### Theming
177
+
## Some references
203
178
204
-
A variety of beautiful theme colors have been selected for you to choose from. The default is purple, but you can quickly change it by editing the `--global-theme-color` variable in the `_sass/_themes.scss` file. Other color variables are listed there as well. The stock theme color options available can be found at [\_sass/\_variables.scss](_sass/_variables.scss). You can also add your own colors to this file assigning each a name for ease of use across the template.
179
+
Check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/) to learn more about Jekyll. Why Jekyll? Read [Andrej Karpathy's blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/). Some other original references: [INSTALL.md](INSTALL.md), [CUSTOMIZE.md](CUSTOMIZE.md).
0 commit comments