|
1 | 1 | --- |
2 | 2 | title: Why make a website for your research? |
3 | | -format: |
4 | | - html: |
5 | | - page-layout: full |
| 3 | +format: |
| 4 | + revealjs: |
| 5 | + theme: simple |
| 6 | + slide-number: true |
| 7 | + preview-links: false |
6 | 8 | --- |
7 | 9 |
|
8 | | -Quarto lets you create free, professional websites. This page explains why researchers use them and the kinds of things you can make. |
| 10 | +## This workshop |
9 | 11 |
|
10 | | -## Your research project |
| 12 | +In this workshop, we're going to teach you how to use **Quarto** to create websites. |
11 | 13 |
|
12 | | -Research tends to accumulate across many different places - Word documents, PDFs, data files, presentations, emails, code repositories. It can be hard for collaborators to find things, and nearly impossible for anyone outside the project to navigate. Much of it stays hidden. |
| 14 | +. . . |
13 | 15 |
|
14 | | -A Quarto website can bring everything together in one place that anyone can visit. It's relevant to any kind of research (qualitative or quantitative) and you can include whatever makes sense for your project: |
| 16 | +But first, **why would you want to?** |
| 17 | + |
| 18 | +. . . |
| 19 | + |
| 20 | +There are many ways researchers use Quarto websites... |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## Ways researchers use Quarto websites |
| 25 | + |
| 26 | +1. Research projects |
| 27 | +2. Programme or team homepage |
| 28 | +3. Training, modules, and courses |
| 29 | +4. Researcher profiles |
| 30 | +5. Manuscripts |
| 31 | +6. Conferences and events |
| 32 | +7. Package documentation |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## 1. Research projects |
| 37 | + |
| 38 | +Research tends to accumulate across many different places: |
| 39 | + |
| 40 | +- Word documents, PDFs, data files |
| 41 | +- Presentations and emails |
| 42 | +- Code repositories |
| 43 | + |
| 44 | +. . . |
| 45 | + |
| 46 | +Hard for collaborators to find things, and nearly impossible for anyone outside the project to navigate. **Much of it stays hidden.** |
| 47 | + |
| 48 | +--- |
| 49 | + |
| 50 | +## 1. Research projects |
| 51 | + |
| 52 | +A Quarto website brings everything together in **one place that anyone can visit**. |
| 53 | + |
| 54 | +Relevant to any kind of research (qualitative or quantitative). |
| 55 | + |
| 56 | +. . . |
| 57 | + |
| 58 | +A project website might include: |
15 | 59 |
|
16 | 60 | - An overview of the study and its aims |
17 | 61 | - Relevant documents, reports, and materials |
18 | 62 | - Embedded videos, presentations, and visualisations |
19 | 63 | - Notes, updates, or a log of progress |
20 | 64 |
|
21 | | -If your research involves code (Python, R, etc.), you can go further: run code directly within the site, display outputs automatically, and embed interactive figures. But none of that is required. |
| 65 | +--- |
| 66 | + |
| 67 | +## 1. Research projects |
| 68 | + |
| 69 | +Can accompany a journal paper as a richer alternative to a standard appendix: |
22 | 70 |
|
23 | | -A project website can accompany a journal paper as a richer alternative to a standard appendix - searchable, mixed media, and openly accessible to anyone. Or it can simply serve as a research compendium: everything in one place, properly organised. |
| 71 | +- Searchable |
| 72 | +- Mixed media |
| 73 | +- Openly accessible to anyone |
24 | 74 |
|
25 | | -Example: |
| 75 | +. . . |
| 76 | + |
| 77 | +Or serve as a **research compendium** (everything in one place, properly organised). |
| 78 | + |
| 79 | +. . . |
| 80 | + |
| 81 | +If your research involves code (Python, R, etc.), you can run code directly within the site, display outputs automatically, and embed interactive figures. |
| 82 | + |
| 83 | +--- |
26 | 84 |
|
27 | 85 | <iframe |
28 | | - class="auto-preview" |
29 | 86 | width="100%" |
30 | | - height="800" |
| 87 | + height="100%" |
31 | 88 | src="https://the-epic-study.quarto.pub/the-epic-project/" |
32 | | - title="The Early Psychosis: Investigating Cognition (EPIC) Project"> |
| 89 | + title="The Early Psychosis: Investigating Cognition (EPIC) Project" |
| 90 | + style="border:none;"> |
33 | 91 | </iframe> |
34 | 92 |
|
35 | | -## Homepage for a research programme or team |
| 93 | +--- |
| 94 | + |
| 95 | +## 2. Programme or team homepage |
36 | 96 |
|
37 | | -If you lead a group, collaborate across institutions, or are part of a larger programme of work, a Quarto website can serve as the public-facing home for everything you do. |
| 97 | +If you lead a group, collaborate across institutions, or are part of a larger programme, a Quarto website can be the **public-facing home for everything you do**. |
38 | 98 |
|
39 | | -This might include: |
| 99 | +. . . |
40 | 100 |
|
41 | 101 | - An overview of the programme's aims and funding |
42 | | -- Profiles of team members (Quarto has built-in "about page" templates) |
| 102 | +- Profiles of team members |
43 | 103 | - A list of outputs: papers, datasets, tools, presentations |
44 | 104 | - News or blog posts about recent developments |
45 | 105 | - Links to resources for collaborators or the public |
46 | 106 |
|
47 | | -Example: |
| 107 | +--- |
48 | 108 |
|
49 | 109 | <iframe |
50 | | - class="auto-preview" |
51 | 110 | width="100%" |
52 | | - height="800" |
| 111 | + height="100%" |
53 | 112 | src="https://pythonhealthdatascience.github.io/stars/" |
54 | | - title="STARS"> |
| 113 | + title="STARS" |
| 114 | + style="border:none;"> |
55 | 115 | </iframe> |
56 | 116 |
|
57 | | -## Training, modules, and courses |
| 117 | +--- |
| 118 | + |
| 119 | +## 3. Training, modules, and courses |
| 120 | + |
| 121 | +Quarto is widely used for **teaching materials**. |
58 | 122 |
|
59 | | -Quarto is widely used for teaching materials. Course notes, worked examples, exercises, and slide decks can all live together on one structured, searchable site that learners can work through |
| 123 | +Course notes, worked examples, exercises, and slide decks can all live together on one structured, searchable site. |
60 | 124 |
|
61 | | -The site can be open to anyone, easy to update and verion controlled, so you always know what changed and when. |
| 125 | +. . . |
62 | 126 |
|
63 | | -Example: |
| 127 | +- Open to anyone |
| 128 | +- Easy to update |
| 129 | +- Version controlled - you always know what changed and when |
| 130 | + |
| 131 | +--- |
64 | 132 |
|
65 | 133 | <iframe |
66 | | - class="auto-preview" |
67 | 134 | width="100%" |
68 | | - height="800" |
| 135 | + height="100%" |
69 | 136 | src="https://sta210-s22.github.io/website/" |
70 | | - title="STA 210: Regression Analysis"> |
| 137 | + title="STA 210: Regression Analysis" |
| 138 | + style="border:none;"> |
71 | 139 | </iframe> |
72 | 140 |
|
73 | | -## Researcher profiles |
| 141 | +--- |
74 | 142 |
|
75 | | -You can create a personal academic website that goes far beyond a LinkedIn profile or institutional staff page. A researcher profile site lets you present your work exactly as you want to, with your own design and structure. You can include your biography, research interests, publications, teaching, and links to your other profiles online. |
| 143 | +## 4. Researcher profiles |
76 | 144 |
|
77 | | -You can also have a blog - a place to share updates, write about your work, or post short pieces between papers. |
| 145 | +Create a **personal academic website** that goes far beyond a LinkedIn profile or institutional staff page, and moves with you if you change institutions. |
78 | 146 |
|
79 | | -It can also move with you if you change institutions. |
| 147 | +. . . |
80 | 148 |
|
81 | | -Example: |
| 149 | +- Present your work exactly as you want to |
| 150 | +- Biography, research interests, publications, teaching |
| 151 | +- Links to ORCID, Google Scholar, GitHub, and more |
| 152 | +- A blog - share updates, write about your work, post short pieces between papers |
| 153 | + |
| 154 | +--- |
82 | 155 |
|
83 | 156 | <iframe |
84 | | - class="auto-preview" |
85 | 157 | width="100%" |
86 | | - height="800" |
| 158 | + height="100%" |
87 | 159 | src="https://amyheather.github.io/" |
88 | | - title="Amy Heather"> |
| 160 | + title="Amy Heather" |
| 161 | + style="border:none;"> |
89 | 162 | </iframe> |
90 | 163 |
|
91 | | -## Manuscripts |
| 164 | +--- |
| 165 | + |
| 166 | +## 5. Manuscripts |
| 167 | + |
| 168 | +Quarto has a dedicated **manuscripts format** for scholarly articles. |
92 | 169 |
|
93 | | -Quarto has a dedicated manuscripts format for scholarly articles. You write your paper in Quarto and can output it as a website, a PDF, or a Word document - all from the same source file. |
| 170 | +Write your paper in Quarto and output it as a website, a PDF, or a Word document - all from the same source file. |
94 | 171 |
|
95 | | -This won't be relevant to everyone - but for research involving data analysis, you can embed code meaning your figures and results are always generated directly from the analysis — nothing can go out of sync. |
| 172 | +. . . |
96 | 173 |
|
97 | | -Example: |
| 174 | +::: {.callout-note} |
| 175 | +This won't be relevant to everyone. But for research involving data analysis, embedding code means your figures and results are always generated directly from the analysis — nothing can go out of sync. |
| 176 | +::: |
| 177 | + |
| 178 | +--- |
98 | 179 |
|
99 | 180 | <iframe |
100 | | - class="auto-preview" |
101 | 181 | width="100%" |
102 | | - height="800" |
| 182 | + height="100%" |
103 | 183 | src="https://daniel1noble.github.io/ecoevo_1000/" |
104 | | - title="Supplementary Materials for: The promise of community-driven preprints in ecology and evolution"> |
| 184 | + title="Supplementary Materials for: The promise of community-driven preprints in ecology and evolution" |
| 185 | + style="border:none;"> |
105 | 186 | </iframe> |
106 | 187 |
|
107 | | -## Conferences and events |
| 188 | +--- |
| 189 | + |
| 190 | +## 6. Conferences and events |
| 191 | + |
| 192 | +If you are hosting an event (e.g., a workshop, symposium, summer school, or conference), Quarto works well here too. |
108 | 193 |
|
109 | | -If you are hosting an event - a workshop, symposium, summer school, or conference - Quarto works well here too. You can publish the programme, abstracts, speaker information, and practical details before the event, then add slides, recordings, and notes afterwards, all on the same site. |
| 194 | +. . . |
110 | 195 |
|
111 | | -Because the site is just files in a repository, multiple organisers can contribute to it, and it can be updated easily as the event approaches and after it ends. |
| 196 | +- Publish the programme, abstracts, and speaker information **before** the event |
| 197 | +- Add slides, recordings, and notes **afterwards** |
| 198 | +- Multiple organisers can contribute via the repository |
| 199 | +- Easy to update as the event approaches and after it ends |
112 | 200 |
|
113 | | -Example: |
| 201 | +--- |
114 | 202 |
|
115 | 203 | <iframe |
116 | | - class="auto-preview" |
117 | 204 | width="100%" |
118 | | - height="800" |
| 205 | + height="100%" |
119 | 206 | src="https://drganghe.github.io/climate-guest-speakers/" |
120 | | - title="Climate Guest Speakers"> |
| 207 | + title="Climate Guest Speakers" |
| 208 | + style="border:none;"> |
121 | 209 | </iframe> |
122 | 210 |
|
123 | | -## Package documentation |
| 211 | +--- |
| 212 | + |
| 213 | +## 7. Package documentation |
| 214 | + |
| 215 | +If you develop a software package in Python, R, or another language, Quarto is a great way to write its documentation. |
124 | 216 |
|
125 | | -If you develop a software package - in Python, R, or another language - Quarto is a great way to write its documentation. You can include installation instructions, usage guides, tutorials, and examples, all in one navigable site. |
| 217 | +Installation instructions, usage guides, tutorials, and examples, all in one navigable site. |
126 | 218 |
|
127 | | -Example: |
| 219 | +--- |
128 | 220 |
|
129 | 221 | <iframe |
130 | | - class="auto-preview" |
131 | 222 | width="100%" |
132 | | - height="800" |
133 | | - src="http://hsma-tools.github.io/vidigi/vidigi_docs/" |
134 | | - title="vidigi"> |
| 223 | + height="100%" |
| 224 | + src="https://hsma-tools.github.io/vidigi/vidigi_docs/" |
| 225 | + title="vidigi" |
| 226 | + style="border:none;"> |
135 | 227 | </iframe> |
136 | 228 |
|
| 229 | +--- |
| 230 | + |
137 | 231 | ## Next steps |
138 | 232 |
|
139 | | -The rest of this tutorial will walk you through how to create a Quarto website from scratch — we'll build one together. |
| 233 | +::: columns |
| 234 | +::: {.column width="60%"} |
| 235 | + |
| 236 | +The rest of this tutorial will walk you through how to create a Quarto website from scratch — **we'll build one together**. |
| 237 | + |
| 238 | +[Go to tutorial →](/pages/setup.qmd) |
| 239 | + |
| 240 | +At the end, head to the [Examples](examples.qmd) page to see a much larger collection of real research websites built with Quarto, covering all of the categories above and more. |
| 241 | + |
| 242 | +::: |
| 243 | + |
| 244 | +::: {.column width="40%"} |
| 245 | + |
| 246 | +[](/pages/examples.qmd) |
140 | 247 |
|
141 | | -When you reach the end, head to the [Examples](examples.qmd) page to see a much larger collection of real research websites built with Quarto, covering all of the categories above and more. |
| 248 | +::: |
| 249 | +::: |
0 commit comments