- Module Maintainer: Julius Schäper (
@jfschaeper) - Course: pp4rs.github.io
- Institute: Dept of Economics, Uni Zurich
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.
The site is rendered using MkDocs and build using GitHub actions.
If you want to build the site locally on your machine:
- Change your working directory to this one, and then create an environment with the necessary packages:
conda env create -f environment.yml -n <env_name>
- Look at a copy of the site served locally on your machine:
mkdocs serve
- The website will be served at http://127.0.0.1:8000/.
If you want to host the website on GitHub pages:
- Change your working directory to this one and run:
mkdocs gh-deploy
-
Behind the scenes, MkDocs will build your docs and use the ghp-import tool to commit them to the gh-pages branch and push the gh-pages branch to GitHub.
-
Now navigate to 'Settings' in the GitHub repository and make sure 'Build and Deployment' has its source set to 'Deploy from a branch' and choose the 'gh-pages' branch with 'root' as the folder origin.
-
After a short period of time the website should be available.
All materials are licensed under a Creative Commons CC-SA license. The license allows you to copy, remix and redistribute any of our publicly available materials, under the condition that you attribute the work (details in the license). More information is available here
The suggested citation for the course materials is:
Julius Schäper, 2024, Programming Practices for Research in Economics, University of ZurichIf you find the installation guide useful - please drop us a line and say so - pp4rs@econ.uzh.ch
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.