GitHub Pages for my website. The webiste will be rendered using Quarto and published to GitHub Pages. Please visit here for the rendered website.
The main
branch is protected so that one needs to create a pull request to make changes. To do this, it is recommended to follow the steps:
- Make changes to the
qmd
andsetting
files (such as_quarto.yml
); - Render the project locally using
quarto render
to see the desired changes have been made; - Push the changes to GitHub and create a pull request;
- The
render-only
workflow will be triggered by the pull request; - Once the
render-only
test passes, the pull request can be merged to themain
branch;
As the website is not supposed to track every detailed step, it is recommened to use squash
merging startegy to combine all the changes into one commit. If you have squashed the commits already into a few big steps, you may also use the rebase
merging strategy.
After the merging, the feature branch may be different from the main, you can run the following command to sync the feature branch with main:
git checkout main
git pull
git pull --rebase origin main
git checkout feature
git rebase main
git push -f