Skip to content

Commit 292b26d

Browse files
committed
add workshop update and jekyll guide
1 parent e0af710 commit 292b26d

1 file changed

Lines changed: 59 additions & 3 deletions

File tree

README.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ IQ-TREE at a workshop, you can update the markdown files in the
1515
<https://iqtree.github.io/workshop/>. Below are the guidelines how to
1616
contribute.
1717

18-
First, you should clone the repo to your local machine using git:
18+
First, you should clone the repo to your local machine using git via the command
19+
line:
1920

2021
```
2122
git clone https://github.com/iqtree/iqtree.github.io.git
@@ -71,13 +72,68 @@ git commit -am "Message about this commit"
7172
Please make the message concise but informative about what you did. Then you
7273
can make a pull request to ask us to update the main repo. An IQ-TREE team
7374
member will review your pull request before deciding to merge it into the main
74-
site, optional modifications to your pull request. Occasionally, the
75+
site, optionally with modifications to your pull request. Occasionally, the
7576
IQ-TREE member may ask you to revise your pull request, before making decision.
7677

7778
Updating a workshop
7879
-------------------
7980

8081
The workshop materials are in the [workshop](workshop/) subfolder. There are already
81-
some past workshops that you can have a look.
82+
some past workshops that you can have a look. If you are teaching a new workshop,
83+
you can copy and reuse past ones, e.g.,
8284

85+
```
86+
# copy file under Linux or Mac, assuming your current directory is workshop/
87+
cp molevol2023.md myworkshop.md
88+
```
89+
90+
Then you can change `myworkshop.md` and add it to git:
91+
92+
```
93+
git add myworkshop.md
94+
```
95+
96+
Moreover, you may want to change `index.md` file ([link](workshop/index.md)) to
97+
add yours to the list of workshops showing at
98+
<https://iqtree.github.io/workshop/>.
99+
100+
And make sure that you also update the header fields `author` and `date` as
101+
shown in the [previous section](#updating-iq-tree-documentation). Once you are
102+
satisfied with the changes you can then commit it:
103+
104+
```
105+
git commit -am "Message about this commit"
106+
```
107+
108+
Please make the message concise but informative about what you did. Then you
109+
can make a pull request to ask us to update the main repo. An IQ-TREE team
110+
member will review your pull request before deciding to merge it into the main
111+
site, optionally with modifications to your pull request. Occasionally, the
112+
IQ-TREE member may ask you to revise your pull request, before making decision.
113+
114+
Creating a local website for double-checking
115+
--------------------------------------------
116+
117+
Before making a pull request, you can optionally create the website locally on
118+
your own machine using the [jekyll](https://jekyllrb.com) tool (in fact, GitHub
119+
also uses `jekyll` to auto-create the website). That way, you can check yourself
120+
whether the changes will display as what you intended.
121+
122+
You need to first have `jekyll` installed. On a MacOS, if you have Homebrew installed,
123+
you can install `jekyll` via a simple command:
124+
125+
```
126+
brew install jekyll
127+
```
128+
129+
If not, check the [jekyll](https://jekyllrb.com) website for an installation guide.
130+
131+
Then in the `iqtree.github.io` folder, please run the command line:
132+
133+
```
134+
jekyll serve
135+
```
136+
137+
This will create a virtual website at http://127.0.0.1:4000/. You can go to this address
138+
on a web browser to see how it looks like.
83139

0 commit comments

Comments
 (0)