Skip to content

Commit 88faf09

Browse files
authored
Create README.md
1 parent cfd5078 commit 88faf09

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# MIST Lab Website Source
2+
3+
This repository contains the source files for the MIST Lab website built with [Nikola](https://getnikola.com/). The `master` branch is automatically generated from the contents of the `src` branch. Thus, when editing the website, you must only edit the `src` branch.
4+
5+
## Editing Your Personal Page
6+
7+
All personal pages are stored under the `people/` directory. To create or update your page:
8+
9+
1. `git clone -b src https://github.com/MISTLab/mistlab.github.io.git`
10+
2. Create a new folder under `people/` named after your name (Try to follow the same name partern).
11+
3. Add an `index.md` file with your biography and other content in Markdown format.
12+
4. Create a `person.ini` file to describe yourself:
13+
```ini
14+
[Person]
15+
Name = Your Name
16+
Occupation = Your Title (E.g. Master Student)
17+
Tagline = Short description
18+
Image = /people/<your_folder>/<your_photo>
19+
```
20+
You can also add social links such as `Twitter`, `Linkedin`, etc.
21+
5. Create a new folder under `files/people/` with the same name as the one under `people/`.
22+
6. Place your landscape (ratio of arround 1.6) picture and use the name from `Image` field of your `person.ini`.
23+
7. Commit your change.

0 commit comments

Comments
 (0)