Skip to content

Commit 50e367e

Browse files
committed
added readme
1 parent 02025de commit 50e367e

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

readme.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# DASC Lab Website
2+
3+
4+
## Local Development
5+
Install Hugo, following the steps at https://gohugo.io/installation/
6+
This website was built using Hugo v0.132.1
7+
8+
To see the website locally, run
9+
```
10+
hugo server
11+
```
12+
and navigate to the url, usually `http://localhost:1313/`.
13+
14+
After the changes have been made, commit them onto a new branch, and create a PR to merge the content into `main`.
15+
The github workflows will automatically deploy the new version of the website.
16+
17+
## Adding Content
18+
19+
20+
### Adding a person
21+
22+
To add a new person, starting from the root directory, run
23+
```
24+
hugo new content person/$id.md
25+
```
26+
where `$id` must be replaced by the id you want to create.
27+
28+
Navigate to `/content/people/$id.md` and edit the front matter.
29+
After the front matter, you can add more details. These will be rendered on `dasc-lab.github.io/people/$id` page.
30+
31+
### Adding a paper
32+
33+
Similarly, to add a paper, run
34+
```
35+
hugo new content papers/$id.md
36+
```
37+
and then edit `/contents/papers/$id/md`. Again, you can add more info after the front matter, to have it render on the individual page.
38+
39+
If you link the author id correctly, each author's page will be automatically updated to include all the papers too.
40+
41+
## Styles and Layout
42+
43+
This website uses boostrap https://getbootstrap.com/ v5.3.3 to create styles.
44+
45+
To customize additional css, edit `/layouts/partials/style.html`.
46+
To customize how the `person` and `papers` render, edit `/layouts/partials/person-card` or `/layouts/partials/paper-card`.
47+
48+
49+
## TODO
50+
- add search functionality
51+
- add projects
52+
- add news
53+
- fix homepage

0 commit comments

Comments
 (0)