Merge pull request #1 from PREPONDERANCE/dev

Basic Settings

.github/workflows/deploy_docs.yml

@@ -0,0 +1,30 @@
+name: deploy_docs
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
+        working-directory: ./notes

notes/docs/index.md

@@ -0,0 +1,19 @@
+# CS231n Notes
+
+## Introduction
+
+This repository will hold notes on [CS231n course](https://cs231n.stanford.edu/schedule.html).
+
+## Project Layout
+
+```bash
+.
+├─ assignments/
+│  └─ assignment1
+│  └─ assignment2
+│  └─ assignment3
+├─ docs/
+│  └─ content
+│  └─ index.md
+└─ mkdocs.yml
+```

notes/mkdocs.yml

@@ -0,0 +1,49 @@
+site_name: CS231n
+repo_url: https://github.com/PREPONDERANCE/CS231n
+repo_name: CS231n Notes
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - attr_list
+  - md_in_html
+
+extra_javascript:
+  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
+
+theme:
+  name: material
+  favicon: assets/logo.jpg
+  features:
+    - search.share
+    - search.suggest
+    - navigation.footer
+    - content.code.copy
+    - content.code.annotate
+  palette:
+    - media: "(prefers-color-scheme)"
+      primary: indigo
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode