Skip to content

Commit

Permalink
migrate repo to 790gradML
Browse files Browse the repository at this point in the history
  • Loading branch information
@shensquared
shensquared committed Aug 29, 2024
1 parent b531f23 commit aaf9683
Show file tree
Hide file tree
Showing 5 changed files with 117 additions and 117 deletions.
218 changes: 109 additions & 109 deletions _config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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/
Expand Down
8 changes: 4 additions & 4 deletions _docs/_contents.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -13,14 +13,14 @@ 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/"
values:
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 `<repo root>/reinforcement` folder to organize the corresponding drop-down module. Similarly, under `<repo root>/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 `<repo root>/reinforcement` folder to organize the corresponding drop-down module. Similarly, under `<repo root>/supervised/`, the `learnability_and_vc.md` file is rendered as the `gradml.mit.edu/supervised/learnability_and_vc/` page.
4 changes: 2 additions & 2 deletions _docs/_devs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion _layouts/default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
👋 Hi there!
This is a <b>draft</b> site currently under construction 🚧.
(Bug reports very <a
href="https://github.com/shensquared/gradML/issues">welcome</a> though; thanks!)<br>
href="https://github.com/790gradml/gradML/issues">welcome</a> though; thanks!)<br>
-->

<main>
Expand Down
2 changes: 1 addition & 1 deletion credits.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit aaf9683

Please sign in to comment.