From aaf96836bfed045b4448c50aa03bc104554c4547 Mon Sep 17 00:00:00 2001 From: Shen Shen Date: Wed, 28 Aug 2024 20:19:32 -0400 Subject: [PATCH] migrate repo to `790gradML` --- _config.yml | 218 +++++++++++++++++++++--------------------- _docs/_contents.md | 8 +- _docs/_devs.md | 4 +- _layouts/default.html | 2 +- credits.md | 2 +- 5 files changed, 117 insertions(+), 117 deletions(-) diff --git a/_config.yml b/_config.yml index 17c4ffb..ac704fe 100644 --- a/_config.yml +++ b/_config.yml @@ -33,19 +33,19 @@ url: "https://gradml.mit.edu" # the base hostname & protocol for your site, e.g. heading_anchors: true permalink: pretty aux_links: - Canvas: - - "https://canvas.mit.edu/courses/28217" - Piazza: - - "https://piazza.com/class/lzy7kgi6f2n4fs/" + Canvas: + - "https://canvas.mit.edu/courses/28217" + Piazza: + - "https://piazza.com/class/lzy7kgi6f2n4fs/" aux_links_new_tab: true #remote_theme: just-the-docs/just-the-docs plugins: - - jekyll-feed - - jekyll-default-layout - # - jekyll-pandoc - - jekyll-last-modified-at - - jekyll-seo-tag + - jekyll-feed + - jekyll-default-layout + # - jekyll-pandoc + - jekyll-last-modified-at + - jekyll-seo-tag # Back to top link back_to_top: true @@ -55,14 +55,14 @@ nav_next_prev: true last_edit_timestamp: true gh_edit_link: true # show or hide edit this page link gh_edit_link_text: "✏️ Edit this page on GitHub" -gh_edit_repository: "https://github.com/shensquared/gradML" +gh_edit_repository: "https://github.com/790gradml/gradML" gh_edit_branch: "main" # the branch that your docs is served from # gh_edit_source: docs # the source that your files originate from gh_edit_view_mode: "tree" # Optional. The default date format, used if none is specified in the tag. last-modified-at: - date-format: "%d-%b-%Y" + date-format: "%d-%b-%Y" # kramdown: # math_engine: katex # input: GFMKatex # GFMKatex class from sp301415 is in _plugins/server-side-math.rb @@ -87,82 +87,82 @@ last-modified-at: # color_scheme: wider exclude: - - .sass-cache/ - - .jekyll-cache/ - - gemfiles/ - - Gemfile - - Gemfile.lock - - node_modules/ - - vendor/bundle/ - - vendor/cache/ - - vendor/gems/ - - vendor/ruby/ - - venv/ - - gradML_sources - - booksNotes/ + - .sass-cache/ + - .jekyll-cache/ + - gemfiles/ + - Gemfile + - Gemfile.lock + - node_modules/ + - vendor/bundle/ + - vendor/cache/ + - vendor/gems/ + - vendor/ruby/ + - venv/ + - gradML_sources + - booksNotes/ # Collections for website data collections: - staffers: - modules: - schedules: - announcements: + staffers: + modules: + schedules: + announcements: - # Define a collection named "resource", its documents reside in the "_resource" directory - # resource: - #permalink: "/:collection/:path/" - # permalink: "/:path/" - # output: true + # Define a collection named "resource", its documents reside in the "_resource" directory + # resource: + #permalink: "/:collection/:path/" + # permalink: "/:path/" + # output: true # Default layouts for each collection type defaults: - - scope: - path: "" - type: staffers - values: - layout: staffer - subpath: "/assets/images/" - - scope: - path: "" - type: modules - values: - layout: module - - scope: - path: "" - type: schedules - values: - layout: schedule - - scope: - path: "" - type: announcements - values: - layout: announcement - - scope: - path: "supervised/" - values: - parent: Supervised Learning - layout: page - katex: true - - scope: - path: "reinforcement/" - values: - parent: Reinforcement Learning - layout: page - - scope: - path: "unsupervised/" - values: - parent: Unsupervised Learning - layout: page - - scope: - path: "info/" - values: - parent: Info - layout: page - info_cat: true - - scope: - path: "homeworks/" - values: - parent: Homeworks - layout: page - permalink: homeworks/:basename/ + - scope: + path: "" + type: staffers + values: + layout: staffer + subpath: "/assets/images/" + - scope: + path: "" + type: modules + values: + layout: module + - scope: + path: "" + type: schedules + values: + layout: schedule + - scope: + path: "" + type: announcements + values: + layout: announcement + - scope: + path: "supervised/" + values: + parent: Supervised Learning + layout: page + katex: true + - scope: + path: "reinforcement/" + values: + parent: Reinforcement Learning + layout: page + - scope: + path: "unsupervised/" + values: + parent: Unsupervised Learning + layout: page + - scope: + path: "info/" + values: + parent: Info + layout: page + info_cat: true + - scope: + path: "homeworks/" + values: + parent: Homeworks + layout: page + permalink: homeworks/:basename/ # pandoc: # extensions: # # - normalize @@ -172,33 +172,33 @@ defaults: # callouts callouts_level: quiet # or loud callouts: - definition: - title: Definition - color: yellow - theorem: - title: Theorem - color: eecs-red - proof: - title: Proof - color: eecs-blue - note: - title: Note - color: blue - warning: - title: "" - color: eecs-red - alt-warning: - title: "" - color: yellow - example: - title: "Example" - color: eecs-purple - exercise: - title: "Exercise" - color: blue - solutions: - title: "Solutions" - color: mit-gray + definition: + title: Definition + color: yellow + theorem: + title: Theorem + color: eecs-red + proof: + title: Proof + color: eecs-blue + note: + title: Note + color: blue + warning: + title: "" + color: eecs-red + alt-warning: + title: "" + color: yellow + example: + title: "Example" + color: eecs-purple + exercise: + title: "Exercise" + color: blue + solutions: + title: "Solutions" + color: mit-gray # mermaid: # # Version of mermaid library # # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ diff --git a/_docs/_contents.md b/_docs/_contents.md index cfb2414..8b2d650 100644 --- a/_docs/_contents.md +++ b/_docs/_contents.md @@ -4,7 +4,7 @@ Minor edits like typo fixes can be made by following the `edit link` at the bott Those with write access to this repository can edit directly via the GitHub webUI; a PR can be another approach. Content edits pushed to the `main` branch will be "live" on [`gradML`](https://gradml.mit.edu) within a few seconds. Other changes, like website infrastructure upgrades or feature changes, require a server-side reload. -Below is a quick demo of adding a "gradient vector" blob (commit [`c8d8c5d`](https://github.com/shensquared/gradML/commit/c8d8c5d15cce69b94a6ff0aa980f45e9d4c0cbc2)) +Below is a quick demo of adding a "gradient vector" blob (commit [`c8d8c5d`](https://github.com/790gradml/gradML/commit/c8d8c5d15cce69b94a6ff0aa980f45e9d4c0cbc2)) ![](figs/simpe-edit-demo.gif) @@ -13,9 +13,9 @@ Below is a quick demo of adding a "gradient vector" blob (commit [`c8d8c5d`](htt The [`gradML`](https://gradml.mit.edu) website structure largely mirrors the file system structure (with a few exceptions, detailed later). Every `html` webpage is sourced from a `.md` markdown file. Any markdown file with a filename starting with `_` or located in a folder whose name starts with `_` is skipped and not turned into a webpage, e.g., no files under this `_docs` folder are rendered on [`gradML`](https://gradml.mit.edu). -Top-level navigational pages are placed in the root folder. For example, the site links to [https://gradml.mit.edu/review/](https://gradml.mit.edu/review/) on the homepage since the corresponding source [review.md](https://github.com/shensquared/gradML/blob/main/review.md) is located in the repo's root folder. +Top-level navigational pages are placed in the root folder. For example, the site links to [https://gradml.mit.edu/review/](https://gradml.mit.edu/review/) on the homepage since the corresponding source [review.md](https://github.com/790gradml/gradML/blob/main/review.md) is located in the repo's root folder. -Lower-level structure is declared in the [`_config.yml`](https://github.com/shensquared/gradML/blob/main/_config.yml) file. For example, this blob +Lower-level structure is declared in the [`_config.yml`](https://github.com/790gradml/gradML/blob/main/_config.yml) file. For example, this blob ```yaml - scope: path: "reinforcement/" @@ -23,4 +23,4 @@ Lower-level structure is declared in the [`_config.yml`](https://github.com/shen parent: Reinforcement Learning layout: page ``` -in the [`_config.yml`](https://github.com/shensquared/gradML/blob/37564ca75c73b216f16c1ef165721417ab78ed6b/_config.yml#L144) file tells the site to look for markdown files located in the `/reinforcement` folder to organize the corresponding drop-down module. Similarly, under `/supervised/`, the `learnability_and_vc.md` file is rendered as the `gradml.mit.edu/supervised/learnability_and_vc/` page. +in the [`_config.yml`](https://github.com/790gradml/gradML/blob/37564ca75c73b216f16c1ef165721417ab78ed6b/_config.yml#L144) file tells the site to look for markdown files located in the `/reinforcement` folder to organize the corresponding drop-down module. Similarly, under `/supervised/`, the `learnability_and_vc.md` file is rendered as the `gradml.mit.edu/supervised/learnability_and_vc/` page. diff --git a/_docs/_devs.md b/_docs/_devs.md index dbf499c..e457d3e 100644 --- a/_docs/_devs.md +++ b/_docs/_devs.md @@ -2,7 +2,7 @@ All commands below should be run as command-line shell commands. For example, on Mac, these commands can be run in the built-in App `Terminal`, or `iterm2` (a popular 3rd-party alternative). -1. Clone this repository: `git clone https://github.com/shensquared/gradML.git` +1. Clone this repository: `git clone https://github.com/790gradml/gradML.git` 2. (Important) `cd` to the directory of your clone of this repo @@ -16,7 +16,7 @@ All commands below should be run as command-line shell commands. For example, on - add `eval "$(rbenv init -)"` to your shell, e.g. to `.zshrc` - `rbenv local 3.1.3` - - If on other OS, see https://github.com/shensquared/gradML/pull/11 for some details + - If on other OS, see https://github.com/790gradml/gradML/pull/11 for some details 4. Install [Jekyll](https://jekyllrb.com): `gem install bundler jekyll` diff --git a/_layouts/default.html b/_layouts/default.html index 4429330..e0c44fd 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -21,7 +21,7 @@ 👋 Hi there! This is a draft site currently under construction 🚧. (Bug reports very welcome though; thanks!)
+ href="https://github.com/790gradml/gradML/issues">welcome though; thanks!)
-->
diff --git a/credits.md b/credits.md index 216d710..ace3d3e 100644 --- a/credits.md +++ b/credits.md @@ -11,7 +11,7 @@ Special thanks to: Devavrat Shah, David Sontag, Suvrit Sra, Aaditya Singh, Aniruddh Raghu, Wangzhi Dai, Matthew McDermott, Rares Buhai,Varkey Alumootil, Hongge Chen, Yun-Ta Tsai, Shen Shen, Huitao Shen, Zhongxia Yan - [Russ Tedrake](http://groups.csail.mit.edu/locomotion/russt.html) -- [Open-source Repository Contributors](https://github.com/shensquared/gradML/graphs/contributors) +- [Open-source Repository Contributors](https://github.com/790gradml/gradML/graphs/contributors) for this site's contents and infrastructure.