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
+38-44Lines changed: 38 additions & 44 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
1
# LAB homepage
2
-
This is the git repository, containing the homepage for the eeg-lab at the VIS of the University of Stuttgart.
3
-
The readme will be updated as the project grows, if you feel something is missing, feel free to add an issue.
2
+
This is the git repository, containing the homepage for the EEG lab at the VIS of the University of Stuttgart.
3
+
This README will be updated as the project grows, if you feel something is missing, feel free to add an issue.
4
4
5
-
## How to deploy the website locally
5
+
## Extending and editing the page
6
+
### How to deploy the website locally
6
7
1. Make sure you have [Julia](https://julialang.org/) installed. This Website is running on Julia 1.6.3, but later versions should work as well.
7
8
2. Install Franklin for Julia, by going into the [package manager](https://docs.julialang.org/en/v1/stdlib/Pkg/) and typing `add Franklin; add CSV; add DataStructures`.
8
9
3. Clone this git repository.
@@ -17,14 +18,8 @@ The readme will be updated as the project grows, if you feel something is missin
17
18
18
19
If you experience any trouble, have a look at the Franklin doc: [Quick Start](https://franklinjl.org/#quick_start)
19
20
20
-
### Troubleshooting
21
-
1. If your local preview of the members page shows something along the lines of
22
-
Argument Error: Package CSV not found in current path: Run `import Pkg; Pkg.add("CSV")` to install the CSV package.
23
-
Have a look [here](https://franklinjl.org/code/#projecttoml). This problem might be due to a wrong path in the project.toml or manifest.toml.
24
-
The most reliable way to fix this so far, is deleteing both .toml files and re-adding the packages in julia by cd'ing into the project folder and adding, as well as activating the packages (see link above).
25
-
26
-
## Previewing pull requests
27
-
By following these steps, you can preview changes to the website with pull requests before merging them:
21
+
### Previewing pull requests
22
+
As an alternative to deploying the website locally, you can preview changes to the website with pull requests before merging them:
28
23
1. Clone this git repository
29
24
2. Create a branch: `git checkout -b branch-name`
30
25
3. Make changes
@@ -37,19 +32,45 @@ By following these steps, you can preview changes to the website with pull reque
37
32
7. Preview the website with your changes by visiting the following URL, where you use the number of your pull request: https://s-ccs.github.io/previews/PR{number}/
38
33
8. If everything works as intended, merge the pull request
39
34
40
-
## File Structure
41
-
Generally, the site follows the Franklin folder structure, documented [here](https://franklinjl.org/workflow/#folder_structure). If you just want to edit the content of the website, get familiar with Markdown and the basic functionality of [Franklin](https://franklinjl.org/)
35
+
### Update Team Members
36
+
The team member page is auto generated by the contents in [\_assets\team\ ](https://github.com/s-ccs/s-ccs.github.io/tree/main/_assets/team). You can add, delete or update both current members or alumnis in their respective folders.
37
+
### Naming of the folders
38
+
The folders consist of a number and the team member's name, e.g. `001_benedikt_ehinger `
39
+
The number is for ordering purposes, the name just for readability reasons. The name used for the website is taken from the CSV file
40
+
#### Folder Contents
41
+
The folder of each member needs the following things:
42
+
1. A `.jpg` image, named profile_image.jpg with a size of 360px x 360px.
43
+
2. A `.csv` file, containing all info displayed in the member card.
44
+
##### CSV Structure
45
+
The CSV should use `;` as its delimiter and `newline` as row separator.
46
+
The structure of the file should look like this:
47
+
|title|name|position|interests|contact|
48
+
|-----|----|--------|------|-------|
49
+
|Jun.-Prof.|Benedikt Ehinger|Computational Cognitive Science, Stuttgart Center for Simulation Science/VIS|EEG/Eye-tracking, Methods, Statistics, Visual Processing|[email protected]|
50
+
51
+
### Update Papers list
52
+
For now, papers are sorted by year published. Therefore, for every year there will be a CSV file in `.\_assets\papers\`.
53
+
This CSV file is built like this:
54
+
55
+
|Title|Author|DOI|PDF|
56
+
|-----|------|---|---|
57
+
|name-of-publications|names-of-authors|identifier|link-to-pdf, e.g. `"..\assets\papers\pdf\paper1.pdf"`|
58
+
59
+
If you want to upload the paper directly to the homepage, you can put the pdf of the paper in `..\assets\papers\pdf\`
60
+
Read below on how to update the list.
61
+
62
+
### File Structure
63
+
Generally, the site follows the Franklin folder structure, documented [here](https://franklinjl.org/workflow/#folder_structure). If you just want to edit the content of the website, get familiar with Markdown and the basic functionality of [Franklin](https://franklinjl.org/).
42
64
Folders are made into master pages, linking to the `*.md` pages found in that folder. This allows you to group content. If you don't want a folder to be part of the website you can blacklist it (as well as any other file). If you want to extend the site generation, all scripts can be found under `.\_assets\scritps\`
43
65
44
-
### Blacklists
66
+
####Blacklists
45
67
In the `.\_assets\scritps\` folder is file named `file_blacklist.jl`. It contains all needed blacklist for the site generation.\
46
68
The **file blacklist** lists MD files that should not be reached by any navigation element. The names of the file have to be added in whole, case-sensitive and with file extension.\
47
69
In contrast, the **folder blacklist** only needs keywords and/or symbols that need to be contained in a folder or non-md file to not be part of the website at all, e.g as a toc page to group content. \
48
70
**Uppercase list** is a list of pages, that should be rendered in uppercase in the navigation menu.\
49
71
**Format Blacklist** is a blacklist for names, that shouldn't be formatted at all. In that case the name of the folder is used as is.\
50
72
`E.g. eeg.md becomes EEG and PoRiCS.md becomes PoRiCS`
51
73
52
-
## Extending and editing the page
53
74
### Generation scripts
54
75
Under `.\_assets\scritps\` are all scripts for page generation and similar scripts that should be run after deployement, but before the changes go live. If scripts are added there, they either should be called in `init_dynamics.jl` or manually added to the github action under `.\.github\workflows\Deploy.yml`.
55
76
@@ -67,41 +88,14 @@ Furthermore TOC pages now have an image preview. The images for each tile have t
67
88
### Background Circles
68
89
Teammembers and TOC pages have cirles as a visual feature. These are completely made in CSS. Every box contains a 7x7 grid. With `grid-template-rows` and `grid-template-columns` are the areas defined, in which the individual circles are defined. They can overlap, but they can't start and end in the same box. The circles themself are bordered divs with rounded edges. This makes it fairly easy to make new variations of cirlce patterns. If you want to read up, have a look here: `https://css-tricks.com/snippets/css/complete-guide-grid/`
69
90
70
-
## Update Team Members
71
-
The team member page is auto generated by the contents in [\_assets\team\ ](https://github.com/s-ccs/s-ccs.github.io/tree/main/_assets/team). You can add, delete or update both current members or alumnis in their respective folders.
72
-
### Naming of the folders
73
-
The folders consist of a number and the team member's name, e.g. `001_benedikt_ehinger `
74
-
The number is for ordering purposes, the name just for readability reasons. The name used for the website is taken from the CSV file
75
-
### Folder Contents
76
-
The folder of each member needs the following things:
77
-
1. A `.jpg` image, named profile_image.jpg with a size of 360px x 360px.
78
-
2. A `.csv` file, containing all info displayed in the member card.
79
-
#### CSV Structure
80
-
The CSV should use `;` as its delimiter and `newline` as row separator.
81
-
The structure of the file should look like this:
82
-
|title|name|position|interests|contact|
83
-
|-----|----|--------|------|-------|
84
-
|Jun.-Prof.|Benedikt Ehinger|Computational Cognitive Science, Stuttgart Center for Simulation Science/VIS|EEG/Eye-tracking, Methods, Statistics, Visual Processing|[email protected]|
85
-
86
-
## Update Papers list
87
-
For now, papers are sorted by year published. Therefore, for every year there will be a CSV file in `.\_assets\papers\`.
88
-
This CSV file is built like this:
89
-
90
-
|Title|Author|DOI|PDF|
91
-
|-----|------|---|---|
92
-
|name-of-publications|names-of-authors|identifier|link-to-pdf, e.g. `"..\assets\papers\pdf\paper1.pdf"`|
93
-
94
-
If you want to upload the paper directly to the homepage, you can put the pdf of the paper in `..\assets\papers\pdf\`
95
-
Read below on how to update the list.
96
-
97
-
## Update dynamic content (like Navigation elements and TOC pages)
91
+
### Update dynamic content (like Navigation elements and TOC pages)
98
92
If you add any pages, they will be added to the navigation menu, whenever you push the changes to Github. Same goes for the generation of TOC pages for folders and subfolders. If you want to update the nav bar etc. locally,
99
93
just cd into the folder where you would normally start Franklin. There run
100
94
```
101
95
include("./_assets/scripts/init_dynamics.jl");
102
96
```
103
97
104
-
## Update Lunr search index
98
+
###Update Lunr search index
105
99
If you change any content inside the website, make sure to update the [lunr search index (according to the Franklin.jl docs)](https://franklinjl.org/extras/lunr/):
106
100
1. Make sure you have Lunr and Cheerio installed with:
0 commit comments