Skip to content

Commit 7eaee38

Browse files
committed
fix: docs
1 parent ee271dd commit 7eaee38

File tree

6 files changed

+584
-668
lines changed

6 files changed

+584
-668
lines changed

.github/workflows/build.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
on:
2+
pull_request:
3+
branches: [main]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-22.04
8+
9+
steps:
10+
- name: Checkout Repository
11+
uses: actions/checkout@v4
12+
13+
- name: Install dependency
14+
run: npm i
15+
16+
- name: Build
17+
run: npm run build

.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: yarn install --frozen-lockfile
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
File renamed without changes.

docusaurus.config.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ import type { Config } from "@docusaurus/types";
33
import { themes as prismThemes } from "prism-react-renderer";
44

55
const config: Config = {
6-
title: "NKUST iOS Club",
7-
tagline: "NKUST iOS Club",
6+
title: "TREM Docs",
7+
tagline: "TREM Docs",
88
favicon: "img/favicon.ico",
99

1010
// Set the production url of your site here
11-
url: "https://NKUST-iOS-Club.github.io",
11+
url: "https://exptechtw.github.io",
1212
// Set the /<baseUrl>/ pathname under which your site is served
1313
// For GitHub pages deployment, it is often '/<projectName>/'
1414
baseUrl: "/",
1515

1616
// GitHub pages deployment config.
1717
// If you aren't using GitHub pages, you don't need these.
18-
organizationName: "NKUST-iOS-Club", // Usually your GitHub org/user name.
18+
organizationName: "ExpTechTW", // Usually your GitHub org/user name.
1919
projectName: "docs", // Usually your repo name.
2020

2121
onBrokenLinks: "throw",
@@ -59,20 +59,20 @@ const config: Config = {
5959
// Replace with your project's social card
6060
// image: 'img/docusaurus-social-card.jpg',
6161
navbar: {
62-
title: "NKUST iOS Club",
62+
title: "TREM Docs",
6363
logo: {
64-
alt: "NKUST iOS Club Logo",
64+
alt: "TREM Docs Logo",
6565
src: "img/logo.svg",
6666
},
6767
items: [
6868
{
6969
type: "docSidebar",
70-
sidebarId: "cdpsSidebar",
70+
sidebarId: "tremSidebar",
7171
position: "left",
7272
label: "Swift",
7373
},
7474
{
75-
href: "https://github.com/NKUST-iOS-Club/docs",
75+
href: "https://github.com/ExpTechTW/TREM-Docs",
7676
label: "GitHub",
7777
position: "right",
7878
},
@@ -86,11 +86,11 @@ const config: Config = {
8686
style: "dark",
8787
links: [
8888
{
89-
title: "技術文件",
89+
title: "TREM",
9090
items: [
9191
{
92-
label: "Swift",
93-
to: "/docs/swift/start/",
92+
label: "trem",
93+
to: "/docs/trem/start/",
9494
},
9595
],
9696
},
@@ -99,7 +99,7 @@ const config: Config = {
9999
items: [
100100
{
101101
label: "Discord",
102-
href: "https://discord.gg/pdYbhFBAj8",
102+
href: "https://exptech.com.tw/dc",
103103
},
104104
],
105105
},
@@ -112,7 +112,7 @@ const config: Config = {
112112
},
113113
{
114114
label: "GitHub",
115-
href: "https://github.com/NKUST-iOS-Club",
115+
href: "https://github.com/ExpTechTW",
116116
},
117117
],
118118
},

0 commit comments

Comments
 (0)