Skip to content

Commit

Permalink
Set up Material for MkDocs and GitHub Action
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeAllen13 committed Jan 21, 2025
1 parent 4b25dac commit 0f394a9
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "COMP423 Course Notes",
"image": "mcr.microsoft.com/devcontainers/python:latest",
"customizations": {
"vscode": {
"settings": {},
"extensions": ["ms-python.python"]
}
},
"postCreateCommand": "pip install -r requirements.txt"
}
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: pip install -r requirements.txt
- name: Build and Deploy
run: mkdocs gh-deploy --force
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Welcome to Luke Allen's Course Notes

This is my home page. I will use it to organize and share my course notes.

3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
site_name: COMP423 Course Notes
theme:
name: material
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs-material~=9.5

0 comments on commit 0f394a9

Please sign in to comment.