Skip to content

Commit

Permalink
docs: update README deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
ketozhang committed Aug 4, 2024
1 parent ea4daa8 commit 23e67d3
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
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)

0 comments on commit 23e67d3

Please sign in to comment.