Skip to content

Commit 3980449

Browse files
committed
add deploy flow
1 parent 34ba000 commit 3980449

File tree

5 files changed

+78
-38
lines changed

5 files changed

+78
-38
lines changed

.github/workflows/deploy.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
cache: npm
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
- name: Build website
26+
run: npm run build
27+
28+
- name: Upload Build Artifact
29+
uses: actions/upload-pages-artifact@v3
30+
with:
31+
path: build
32+
33+
deploy:
34+
name: Deploy to GitHub Pages
35+
needs: build
36+
37+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38+
permissions:
39+
pages: write # to deploy to Pages
40+
id-token: write # to verify the deployment originates from an appropriate source
41+
42+
# Deploy to the github-pages environment
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

README.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,7 @@
1-
# Website
1+
# Anyinlover's Cabin
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4-
5-
### Installation
6-
7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
### Build
3+
Here are the source files of my personal website Anyinlover's Cabin.
204

21-
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
5+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
406

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
7+
Have fun exploring!
-2.48 MB
Binary file not shown.

docs/computer_architecture/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Course Overview
3+
description: The readme of computer architecture
4+
sidebar_position: 0
5+
---
6+
This course is based on following open textbooks:
7+
8+
- [Computer Architecture](https://www.cs.umd.edu/~meesh/411/CA-online/index.html) under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
9+
- [Basic Computer Architecture](https://www.cse.iitd.ac.in/~srsarangi/archbooksoft.html) under [CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/)
10+
- [Next-Gen Computer Architecture](https://www.cse.iitd.ac.in/~srsarangi/advbook/index.html) under [CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/)
11+
12+
Thanks for the authers's great work.

docs/digital_design/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Course Overview
3+
description: The readme of Digital Design
4+
sidebar_position: 0
5+
---
6+
This course is based on following open textbooks:
7+
8+
- [An Animated Introduction to Digital Logic Design](https://digitalcommons.njit.edu/oat/1/) under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
9+
- [Introduction to Logic Circuits & Logic Design with Verilog](https://www.dbooks.org/introduction-to-logic-circuits-logic-design-with-verilog-3030136051/) under [CC BY](https://creativecommons.org/licenses/by/4.0/)
10+
11+
Thanks for the authers's great work.

0 commit comments

Comments
 (0)