-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |