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: .github/ISSUE_TEMPLATE/bug_report.md
+3-9Lines changed: 3 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,11 @@ name: Bug report
3
3
about: Create a report to help us improve
4
4
title: ''
5
5
labels: ''
6
-
assignees: ''
7
6
8
7
---
9
8
10
9
**Describe the bug**
11
-
A clear and concise description of what the bug is.
10
+
A clear and concise description of what the bug is, be sure to note if the issue is presenet in the *template* or appeared on *your site*. If the bug appears on your site, please be sure to provide a link to your repository.
12
11
13
12
**To Reproduce**
14
13
Steps to reproduce the behavior:
@@ -23,16 +22,11 @@ A clear and concise description of what you expected to happen.
23
22
**Screenshots**
24
23
If applicable, add screenshots to help explain your problem.
25
24
26
-
**Desktop (please complete the following information):**
25
+
**Browser (please complete the following information):**
26
+
- Device: [e.g. iPhone6] (if applicable)
27
27
- OS: [e.g. iOS]
28
28
- Browser [e.g. chrome, safari]
29
29
- Version [e.g. 22]
30
30
31
-
**Smartphone (please complete the following information):**
1. Register a GitHub account if you don't have one and confirm your e-mail (required!)
9
9
1. Click the "Use this template" button in the top right.
10
-
1. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL.
10
+
1. On the "New repository" page, enter your public repository name as "[your GitHub username].github.io", which will also be your website's URL.
11
11
1. Set site-wide configuration and add your content.
12
12
1. Upload any files (like PDFs, .zip files, etc.) to the `files/` directory. They will appear at https://[your GitHub username].github.io/files/example.pdf.
13
13
1. Check status by going to the repository settings, in the "GitHub pages" section
@@ -17,40 +17,59 @@ See more info at https://academicpages.github.io/
17
17
18
18
## Running locally
19
19
20
-
When you are initially working your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to:
20
+
When you are initially working on your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to:
21
21
22
22
1. Clone the repository and made updates as detailed above.
23
+
24
+
### Using a different IDE
23
25
1. Make sure you have ruby-dev, bundler, and nodejs installed
24
26
25
27
On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is:
26
28
```bash
27
29
sudo apt install ruby-dev ruby-bundler nodejs
28
30
```
31
+
If you see error `Unable to locate package ruby-bundler`, `Unable to locate package nodejs `, run the following:
32
+
```bash
33
+
sudo apt update && sudo apt upgrade -y
34
+
```
35
+
then try run `sudo apt install ruby-dev ruby-bundler nodejs` again.
36
+
29
37
On MacOS the commands are:
30
38
```bash
31
39
brew install ruby
32
40
brew install node
33
41
gem install bundler
34
42
```
35
43
1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
36
-
1. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change.
44
+
45
+
If you see file permission error like `Fetching bundler-2.6.3.gem ERROR: While executing gem (Gem::FilePermissionError) You don't have write permissions for the /var/lib/gems/3.2.0 directory.` or `Bundler::PermissionError: There was an error while trying to write to /usr/local/bin.`
46
+
Install Gems Locally (Recommended):
47
+
```bash
48
+
bundle config set --local path 'vendor/bundle'
49
+
```
50
+
then try run `bundle install` again. If succeeded, you should see a folder called `vendor` and `.bundle`.
51
+
52
+
1. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change to Markdown (*.md) and HTML files, while changes to the core template and configuration (i.e., `_config.yml`) will require stoping and restarting Jekyll.
53
+
You may also try `bundle exec jekyll serve -l -H localhost` to ensure jekyll to use specific dependencies on your own local machine.
37
54
38
55
If you are running on Linux it may be necessary to install some additional dependencies prior to being able to run locally: `sudo apt install build-essential gcc make`
39
56
40
57
## Using Docker
41
58
42
59
Working from a different OS, or just want to avoid installing dependencies? You can use the provided `Dockerfile` to build a container that will run the site for you if you have [Docker](https://www.docker.com/) installed.
43
60
44
-
Start by build the container:
61
+
You can build and execute the container by running the following command in the repository:
45
62
46
63
```bash
47
-
docker build -t jekyll-site .
64
+
chmod -R 777 .
65
+
docker compose up
48
66
```
49
67
50
-
Next, run the container:
51
-
```bash
52
-
docker run -p 4000:4000 --rm -v $(pwd):/usr/src/app jekyll-site
53
-
```
68
+
You should now be able to access the website from `localhost:4000`.
69
+
70
+
### Using the DevContainer in VS Code
71
+
72
+
If you are using [Visual Studio Code](https://code.visualstudio.com/) you can use the [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) that comes with this Repository. Normally VS Code detects that a development coontainer configuration is available and asks you if you want to use the container. If this doesn't happen you can manually start the container by **F1->DevContainer: Reopen in Container**. This restarts your VS Code in the container and automatically hosts your academic page locally on http://localhost:4000. All changes will be updated live to that page after a few seconds.
0 commit comments