init course website

2023/weeks/week01/slides.qmd → 2024/weeks/week01/slides.qmd

@@ -3,8 +3,8 @@ subtitle: "MY_COURSE_CODE -- MY_COURSE_NAME"
 title: "<font style='font-size:1em;'>🗓️ Week 01<br/> Introduction</font>"
 author: Prof. [Octopian](#)
 institute: '[University of Octopus Studies](#)'
-date: 14 March 2023
-date-meta: 14 March 2023
+date: 14 March 2024
+date-meta: 14 March 2024
 date-format: "DD MMM YYYY"
 toc: true
 toc-depth: 1

README.md

@@ -1,63 +1,8 @@
-# Quarto template for university courses
+# Course website for `LLMs in Linguistic Research`
 
-<figure>
-    <img src="./figures/icons/course_favicon.png" alt="Image Created with DALL·E. Prompt: 'octopus-like alien futuristic teacher, abstract award-winning material design favicon blue flat colours'"  role="presentation" style="object-fit: cover;width:5em;height:5em;border-radius: 50%;">
-    <figcaption>
-        <span style="display:inline-block;font-size:0.3em;width:30%;">
-        Image created with DALL·E. Prompt: 'octopus-like alien futuristic teacher, abstract award-winning material design favicon blue flat colours'
-        </span>
-    </figcaption>
-
-</figure>
-
-
-A template for developing university courses using Quarto.
-
-**Real Examples:**
-
-- <img src="https://lse-dsi.github.io/DS101/figures/DS101_favicon.png" style="object-fit: cover;width:1em;height:1em;border-radius: 50%;" /> [LSE DS101](https://lse-dsi.github.io/DS101/) - Fundamentals of Data Science
-- <img src="https://lse-dsi.github.io/DS105/figures/icons/DS105L_favicon.png" style="object-fit: cover;width:1em;height:1em;border-radius: 50%;" /> [LSE DS105](https://lse-dsi.github.io/DS105/) - Data for Data Science
-- <img src="https://lse-dsi.github.io/DS202/figures/icons/favicon_DS202_200px.png" style="object-fit: cover;width:1em;height:1em;border-radius: 50%;" /> [LSE DS202](https://lse-dsi.github.io/DS202/) - Data Science for Social Scientists
-- <img src="https://lse-dsi.github.io/ME204/figures/icons/favicon_ME204_200px.png" style="object-fit: cover;width:1em;height:1em;border-radius: 50%;" /> [LSE ME204](https://lse-dsi.github.io/ME204/) - Data Engineering for the Social World
-
-**New to <img src="https://quarto.org/favicon.png" style="object-fit: cover;width:1em;height:1em;" /> Quarto?**
-
-You will need to understand the basics of the following features of Quarto to make the most of this template. It's worth it!
-
-- Check [their initial tutorial](https://quarto.org/docs/get-started/)
-- Then read about [Quarto websites](https://quarto.org/docs/websites/)
-- Check out also [Revealjs tutorial](https://quarto.org/docs/presentations/revealjs/) to learn how to create modern slides
-- Then move on to learn about [Quarto projects](https://quarto.org/docs/projects/quarto-projects.html)
-
-There you go. You might be wondering how to put all of this to work. That is precisely why this template exists!
+This website is forked from [this template](https://github.com/jonjoncardoso/quarto-template-for-university-courses). Check out their README for instructions on how to use the template. 
 
 # 💡 How to use this template
-
-<details><summary><strong>On GitHub:</strong></summary>
-
-1. Click on the green button **Use this template** then **Create a new repository**.
-
-2. Wait for GitHub to copy the files and run the initial setup (you will see this on the **Actions** tab).
-</details>
-
-<details><summary><strong>Locally in your computer:</strong></summary>
-
-3. Clone your newly created repository to your computer.
-
-4. Follow the instructions written below in the 🧰 [Dev Setup](#dev-setup) section.
-
-5. Skip the R or Python setup if you do not plan on working in one of these languages.
-
-</details>
-
-<details><summary><strong>Start editing the files:</strong></summary>
-
-Here is a guide of the initial files you might want to modify to remove the sections that refer to the template, leaving only what is relevant to developing/updating the material of your course.
-
-6. Start by editing the `README.md` file carefully. 
-    - Change the title
-    - Remove some of the sections
-    - Edit the Dev Setup instructions to cater to your needs.
 7. Add your **course code** and **course name** to the web pages
 
     - If you are using VSCode, you can Ctrl + Shift + F (or ⌘ + Shift + F if you are on Mac) and replace all occurrences of `MY_COURSE_CODE` and `MY_COURSE_NAME` to the code and name of your course, respectively.
@@ -83,82 +28,10 @@ On top of the setup below, I also recommend you use [VSCode](https://code.visual
 
 <details><summary>🐍 The Python setup</summary>
 
-## 🐍 The Python setup
-
-1. Install [Python 3.8](python.org) or higher on your computer.
-2. Install [anaconda](https://www.anaconda.com/products/individual) or [miniconda](https://docs.conda.io/en/latest/miniconda.html) on your computer.
-3. Create a new `conda` environment:
-
-    ```bash
-    conda create -y -n=venv-my-course python=3.10.8
-    ```
-
-    Never worked with conda environments before? Take some time to read [their documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). 
-
-    💡 **Pro-tip**: replace `my-course` with your course code. Say, for example, `venv-ds105`.
-
-4. Activate the environment and make sure you have `pip` installed inside that environment:
-
-    ```bash
-    # the exact `activate` command will vary depending on your OS
-    conda activate venv-my-course 
-    ```
-
-💡 Remember to activate this particular `conda` environment whenever you reopen VSCode/the terminal.
-
-10. Install required libraries
-
-  ```bash
-  pip install -r requirements.txt
-  ```
-
-Now, whenever you open a Jupyter Notebook, you should see the `venv-my-course` kernel available.
-</details>
-
-<details><summary>📊 The R setup</summary>
-
-## 📊 The R setup
-
-1. Open a terminal and navigate to the root of this repository.
-2. Ensure you have **R version 4.2.2** or higher
-3. Open the R console in this same directory and install `renv` package:
-    ```r
-    install.packages("renv")
-    ```
-4. Run `renv::restore()` to install all the packages needed for this project
-5. Whenever you install a new R package, run `renv::snapshot()` to save it on your renv.
-
-</details>
-
-<details><summary><img src="https://quarto.org/favicon.png" style="object-fit: cover;width:1em;height:1em;" /> The Quarto setup</summary>
-
-## <img src="https://quarto.org/favicon.png" style="object-fit: cover;width:1em;height:1em;" /> The Quarto setup
-
-1. Install [Quarto](https://quarto.org/docs/getting-started/installation.html) on your computer.
-2. Run the following command to start the website locally:
-
-    ```bash
-    quarto preview . --render all --no-browser
-    ```
-    This will read the instructions from `_quarto.yml` and render the website locally.
-5. Open your browser and navigate to `http://localhost:<port>/`. That's it!
-
-</details>
-
-<details><summary>🕸️ Publishing the website</summary>
-
 ## 🕸️ Publishing the website
 
 I recommend you set up a **GitHub Action** for this. Just follow the instructions in the official [Quarto instructions](https://quarto.org/docs/publishing/github-pages.html#publish-action).
 
 💡 This template already comes with a GitHub workflow setup. You can find it in the [.github/workflows/publish.yml_](.github/workflows/publish.yml_) file. You just need to rename it to `.github/workflows/publish.yml` (remove the underscore at the end)
 
-</details>
-
-# 📟 Contact
-
-**✋ Questions? Suggestions?** If you are not sure how to do something with the template or have a suggestion for a new feature, start a [discussion](https://github.com/jonjoncardoso/quarto-template-for-university-courses/discussions).
-
-**🐞 Spotted any bugs?** Create a new [Issue](https://github.com/jonjoncardoso/quarto-template-for-university-courses/issues).
-
-**🖼️ Want to show us your courses?** Share a link to your public page on the [discussions page](https://github.com/jonjoncardoso/quarto-template-for-university-courses/discussions) or write me an e-mail.
+</details>

_quarto.yml

@@ -1,59 +1,59 @@
 project:
   type: "website"
-  title: "MY_COURSE_NAME 2022/23"
+  title: "LLMs in Lingustic Research 2024/25"
   output-dir: _output
   render:
     - "index.qmd"
-    - "2023/*.qmd"
-    - "2023/weeks/week01/*.qmd"
+    #- "2024/*.qmd"
+    #- "2024/weeks/week01/*.qmd"
 
 website:
-  title: "MY_COURSE_NAME 2022/23"
+  title: "LLMs in Lingustic Research 2024/25"
   page-navigation: true
   reader-mode: true
   open-graph: true
   twitter-card: 
     creator: "@<twitter-handle>"
     site: "\\@<twitter-handle>"
-  favicon: "figures/icons/course_favicon.png"
+  favicon: "figures/icons/course_logo.png"
   search:
     location: navbar
     type: textbox
   sidebar:
     style: docked
     contents:
-      - href: 2023/index.qmd
+      - href: index.qmd
         text: "🏠 Home"
-      # - href: 2023/syllabus.qmd
+      # - href: 2024/syllabus.qmd
       #   text: "📓 Syllabus"
-      # - href: 2023/communication.qmd
+      # - href: 2024/communication.qmd
       #   text: "📟 Communication"
-      # - href: 2023/assignments.qmd
+      # - href: 2024/assignments.qmd
       #   text: "✍️ Assignments"
       #   contents:
-      #     - href: 2023/assignments/assignment01.qmd
+      #     - href: 2024/assignments/assignment01.qmd
       #       text: "📝 Assignment 01"
-      #     - href: 2023/assignments/assignment02.qmd
+      #     - href: 2024/assignments/assignment02.qmd
       #       text: "📝 Assignment 02"
-      #     - href: 2023/assignments/group_project.qmd
+      #     - href: 2024/assignments/group_project.qmd
       #       text: "👥 Group Project"
-      - section: "🗓️ Weeks"
-        contents:
-         - href: 2023/weeks/week01/page.qmd
-           text: Week 01
-           contents:
-             - href: 2023/weeks/week01/page.qmd
-               text: 👨‍🏫 Lecture Material
-            #  - href: 2023/weeks/week01/lab.qmd
+      #- section: "🗓️ Weeks"
+        #contents:
+         #- href: 2024/weeks/week01/page.qmd
+           #text: Week 01
+           #contents:
+             #- href: 2024/weeks/week01/page.qmd
+               #text: 👨‍🏫 Lecture Material
+            #  - href: 2024/weeks/week01/lab.qmd
             #    text: 💻 Lab Roadmap
-            #  - href: 2023/weeks/week01/appendix.qmd
+            #  - href: 2024/weeks/week01/appendix.qmd
             #    text: 🔖 Appendix
 
   navbar:
     background: primary
   page-footer:
     background: light
-    left: "Copyright 2023, MY INSTITUTION" 
+    left: "License: [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)" 
 
 
 
@@ -63,7 +63,7 @@ csl: references/chicago-author-date.csl
 
 format:
   html:
-    author: Dr. [MY NAME](#)
+    author: Akhilesh Kakolu Ramarao, Anna Sophia Stein
     author-meta: Dr. MY NAME
     date-format: "DD MMMM YYYY"
 

css/custom.scss

@@ -1,4 +1,4 @@
 /*-- scss:defaults --*/
 
-$blue:    #20794D !default;
+$blue:    #3E586D !default;
 /*-- scss:rules --*/