Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
valentina-s authored Jul 15, 2024
1 parent 3e65899 commit 3032760
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Github Pages are static webpages, i.e. the content (mainly `.html` and `.css`) i


## Repo Creation
For simplicity we suggest to create a separate repo for the webpage (separate from the code). We will also provide the option to set it up for the repo that you already have, but that will require more git work. If needed ownership and website name can be changed in the future, so pick something as a starting point.
It is simpler to create a separate repo for the webpage (separate from the code) by using this template. We will also provide the option to set it up for the repo that you already have, but that will require more git work. If needed ownership and website name can be changed in the future, so pick something as a starting point.

### Option 1 (new repo)
* decide on a name for the repository: we suggest to follow the format `DSSGYEAR-name-of-repo` (it will determine the webpage url)
Expand All @@ -28,7 +28,7 @@ For simplicity we suggest to create a separate repo for the webpage (separate fr
* remove all tracked files from it
* pull the files from the template
* push to github the changes to create a public gh-pages branch
* enable publishing through the gh-pages branch (Settings -> GitHub-Pages)
* enable publishing through the gh-pages branch (Settings -> Pages)

```
# make an orphan branch
Expand Down Expand Up @@ -82,9 +82,11 @@ For simplicity we suggest to create a separate repo for the webpage (separate fr

* Some colors and fonts are set in the [`.css file`](https://github.com/uwescience/DSSG-website-template/blob/master/public/css/hyde.css)

* The theme that we are using is called [Hyde](https://github.com/poole/hyde): you can read more details about it below. Feel free to use a different theme ([gh-pages themes](https://pages.github.com/themes/), [Jekyll themes](https://jekyllthemes.io/)), but you will have to figure out how to change it on your own. There are some options to make some of the content executable using the [JupyterBook](https://jupyterbook.org/intro.html) template. [Minima](https://jekyll.github.io/minima/about/) is another very simplistic theme which can include a blog and be adapted as you wish.
* The theme that we are using is called [Hyde](https://github.com/poole/hyde): you can read more details about it below. Feel free to use a different theme ([gh-pages themes](https://pages.github.com/themes/), [Jekyll themes](https://jekyllthemes.io/)), but you will have to figure out how to change it on your own. [Minima](https://jekyll.github.io/minima/about/) is very simplistic theme which can include a blog and be adapted as you wish.

* There are some options to integrate executable notebooks with [JupyterBook](https://jupyterbook.org/intro.html) or [Quarto](https://quarto.org/). Remember that the goal of this website is to be accessible a broad audience, so the front content should not include code.

* If you do not want to rush, make your writings visible on the website, you can work in a fork, or simply work on a markdown file which you can share with your teammates for review (check out [https://hackmd.io/](https://hackmd.io/) for collaborative markdown editing for up to 4 people)).
* If you do not want to rush to make your writings visible on the website, you can work in a fork, or simply work on a markdown file which you can share with your teammates for review (check out [https://hackmd.io/](https://hackmd.io/) for collaborative markdown editing for up to 4 people)).



Expand Down

0 comments on commit 3032760

Please sign in to comment.