From 23e67d307b3407b4325d6d3262d917d8a5c211b7 Mon Sep 17 00:00:00 2001 From: "Keto D. Zhang" Date: Sun, 4 Aug 2024 15:07:32 -0700 Subject: [PATCH] docs: update README deploy --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8f32279e..f4fac72b 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # Notes Personal archive of notes taken for education. -## Deploying +GitHub Actions CI will build and deploy on changes to main. -1. Run the Makefile to build notebook as static webpage +## Local Deploy + +1. Clone https://github.com/ketozhang/Journal to `src/ + +2. Run the Makefile to build notebook as static webpage ```sh $ make -j 8 all ``` -2. Commit and push changes to `_site/` +3. Commit and push changes to `_site/` with commit prefix `[skip ci]` -3. On push, GitHub actions will publish `_site/` +4. Trigger the [publish workflow](https://github.com/ketozhang/notes/actions/workflows/publish.yml)