Skip to content

Commit 9a1bbd1

Browse files
committed
Edit read me
1 parent 1daebc8 commit 9a1bbd1

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@
1111
## Meta-Information
1212

1313
* Module Maintainer: Julius Schäper (`@jfschaeper`)
14-
* Course: [Programming Practices for Research in Economics](https://pp4rs.github.io)
14+
* Course: [pp4rs.github.io](https://pp4rs.github.io)
1515
* Institute: Dept of Economics, Uni Zurich
1616

17+
## Editing the Site
18+
To edit information displayed on the webpage, edit the markdown documents in `docs`. Each `.md` corresponds to one subpage of the webpage. The general structure of the entire webpage is provided by `mkdocs.yml`. To add a new subpage, add it at the desired position in `mkdocs.yml` and create the `.md` file in docs.
19+
1720
## Building the Site
1821

1922
The site is rendered using [MkDocs](https://www.mkdocs.org/) and build using GitHub actions.
@@ -32,7 +35,7 @@ conda env create -f environment.yml -n <env_name>
3235
mkdocs serve
3336
```
3437

35-
* The website will be served at http://127.0.0.1:8000.
38+
* The website will be served at http://127.0.0.1:8000/.
3639

3740
If you want to host the website on GitHub pages:
3841

0 commit comments

Comments
 (0)