Skip to content

Commit 1ab17f7

Browse files
committed
edit: workflows instruction
1 parent c9100f5 commit 1ab17f7

5 files changed

Lines changed: 20 additions & 210 deletions

File tree

README.de.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -161,49 +161,11 @@ Benutzerdefinierte Links aus `links.others` werden zu Befehlen (z.B. `Twitter|ht
161161
- Lokal testen: `index.html` öffnen oder Ordner mit statischem Server bereitstellen.
162162
- GitHub Pages funktioniert sofort.
163163

164-
### Beispiel-GitHub-Actions-Workflow (GitHub Pages)
165-
166-
1. `.github/workflows/` erstellen
167-
2. `pages.yml` hinzufügen:
168-
169-
```yaml
170-
name: Deploy to GitHub Pages
171-
172-
on:
173-
push:
174-
branches: [ main ]
175-
workflow_dispatch:
176-
177-
permissions:
178-
contents: read
179-
pages: write
180-
id-token: write
181-
182-
concurrency:
183-
group: "pages"
184-
cancel-in-progress: true
185-
186-
jobs:
187-
deploy:
188-
environment:
189-
name: github-pages
190-
url: ${{ steps.deployment.outputs.page_url }}
191-
runs-on: ubuntu-latest
192-
steps:
193-
- name: Checkout
194-
uses: actions/checkout@v4
195-
196-
- name: Upload static files
197-
uses: actions/upload-pages-artifact@v3
198-
with:
199-
path: .
200-
201-
- name: Deploy to GitHub Pages
202-
id: deployment
203-
uses: actions/deploy-pages@v4
204-
```
164+
### Beispiel-Pages-Einrichtung (GitHub Pages)
205165

206-
3. **Pages** in den Repo-Einstellungen aktivieren, Quelle: **GitHub Actions**.
166+
1. `template-config.json` zum GitHub-Repository hinzufügen.
167+
2. Die bestehende `.github/workflows/jekyll-gh-pages.yml` löschen.
168+
3. Beispiel-Pages direkt unter **repositories > Settings > Pages** erstellen und einrichten.
207169

208170
## Mitwirken
209171

README.ko.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -161,49 +161,11 @@ generator는 `window.TERMINAL_CONFIG`를 생성합니다:
161161
- 로컬 테스트: `index.html` 열기 또는 정적 서버로 폴더 서빙.
162162
- GitHub Pages 바로 사용 가능.
163163

164-
### GitHub Actions 워크플로 예시 (GitHub Pages)
165-
166-
1. `.github/workflows/` 생성
167-
2. `pages.yml` 추가:
168-
169-
```yaml
170-
name: Deploy to GitHub Pages
171-
172-
on:
173-
push:
174-
branches: [ main ]
175-
workflow_dispatch:
176-
177-
permissions:
178-
contents: read
179-
pages: write
180-
id-token: write
181-
182-
concurrency:
183-
group: "pages"
184-
cancel-in-progress: true
185-
186-
jobs:
187-
deploy:
188-
environment:
189-
name: github-pages
190-
url: ${{ steps.deployment.outputs.page_url }}
191-
runs-on: ubuntu-latest
192-
steps:
193-
- name: Checkout
194-
uses: actions/checkout@v4
195-
196-
- name: Upload static files
197-
uses: actions/upload-pages-artifact@v3
198-
with:
199-
path: .
200-
201-
- name: Deploy to GitHub Pages
202-
id: deployment
203-
uses: actions/deploy-pages@v4
204-
```
164+
### Pages 예시 설정 (GitHub Pages)
205165

206-
3. 저장소 설정에서 **Pages** 활성화, 소스: **GitHub Actions**.
166+
1. `template-config.json`을 GitHub 레포지토리에 추가합니다.
167+
2. 기존 `.github/workflows/jekyll-gh-pages.yml`을 삭제합니다.
168+
3. **repositories > Settings > Pages**에서 직접 예시 페이지를 생성/설정합니다.
207169

208170
## 기여
209171

README.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -161,49 +161,11 @@ Custom links from `links.others` become commands (e.g. `Twitter|https://...` →
161161
- Test locally by opening `index.html` or serving the folder.
162162
- GitHub Pages works out of the box.
163163

164-
### Example GitHub Actions workflow (GitHub Pages)
165-
166-
1. Create `.github/workflows/`
167-
2. Add `pages.yml`:
168-
169-
```yaml
170-
name: Deploy to GitHub Pages
171-
172-
on:
173-
push:
174-
branches: [ main ]
175-
workflow_dispatch:
176-
177-
permissions:
178-
contents: read
179-
pages: write
180-
id-token: write
181-
182-
concurrency:
183-
group: "pages"
184-
cancel-in-progress: true
185-
186-
jobs:
187-
deploy:
188-
environment:
189-
name: github-pages
190-
url: ${{ steps.deployment.outputs.page_url }}
191-
runs-on: ubuntu-latest
192-
steps:
193-
- name: Checkout
194-
uses: actions/checkout@v4
195-
196-
- name: Upload static files
197-
uses: actions/upload-pages-artifact@v3
198-
with:
199-
path: .
200-
201-
- name: Deploy to GitHub Pages
202-
id: deployment
203-
uses: actions/deploy-pages@v4
204-
```
164+
### Example Pages setup (GitHub Pages)
205165

206-
3. Enable **Pages** in repo settings, source: **GitHub Actions**.
166+
1. Add `template-config.json` to the GitHub repository.
167+
2. Delete the existing `.github/workflows/jekyll-gh-pages.yml`.
168+
3. Create and configure example pages directly in **repositories > Settings > Pages**.
207169

208170
## Contributing
209171

README.tr.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -161,49 +161,11 @@ Generator `window.TERMINAL_CONFIG` oluşturur:
161161
- Yerel test: `index.html` açın veya klasörü statik sunucu ile sunun.
162162
- GitHub Pages hazır çalışır.
163163

164-
### Örnek GitHub Actions iş akışı (GitHub Pages)
165-
166-
1. `.github/workflows/` oluşturun
167-
2. `pages.yml` ekleyin:
168-
169-
```yaml
170-
name: Deploy to GitHub Pages
171-
172-
on:
173-
push:
174-
branches: [ main ]
175-
workflow_dispatch:
176-
177-
permissions:
178-
contents: read
179-
pages: write
180-
id-token: write
181-
182-
concurrency:
183-
group: "pages"
184-
cancel-in-progress: true
185-
186-
jobs:
187-
deploy:
188-
environment:
189-
name: github-pages
190-
url: ${{ steps.deployment.outputs.page_url }}
191-
runs-on: ubuntu-latest
192-
steps:
193-
- name: Checkout
194-
uses: actions/checkout@v4
195-
196-
- name: Upload static files
197-
uses: actions/upload-pages-artifact@v3
198-
with:
199-
path: .
200-
201-
- name: Deploy to GitHub Pages
202-
id: deployment
203-
uses: actions/deploy-pages@v4
204-
```
164+
### Örnek Pages kurulumu (GitHub Pages)
205165

206-
3. Repo ayarlarında **Pages**'i etkinleştirin, kaynak: **GitHub Actions**.
166+
1. `template-config.json` dosyasını GitHub deposuna ekleyin.
167+
2. Mevcut `.github/workflows/jekyll-gh-pages.yml` dosyasını silin.
168+
3. **repositories > Settings > Pages** bölümünden doğrudan örnek sayfaları oluşturun ve yapılandırın.
207169

208170
## Katkıda bulunma
209171

README.zh-CN.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -161,49 +161,11 @@ generator 生成 `window.TERMINAL_CONFIG`:
161161
- 本地测试:打开 `index.html` 或用静态服务器托管文件夹。
162162
- GitHub Pages 开箱即用。
163163

164-
### GitHub Actions 工作流示例(GitHub Pages)
165-
166-
1. 创建 `.github/workflows/`
167-
2. 添加 `pages.yml`
168-
169-
```yaml
170-
name: Deploy to GitHub Pages
171-
172-
on:
173-
push:
174-
branches: [ main ]
175-
workflow_dispatch:
176-
177-
permissions:
178-
contents: read
179-
pages: write
180-
id-token: write
181-
182-
concurrency:
183-
group: "pages"
184-
cancel-in-progress: true
185-
186-
jobs:
187-
deploy:
188-
environment:
189-
name: github-pages
190-
url: ${{ steps.deployment.outputs.page_url }}
191-
runs-on: ubuntu-latest
192-
steps:
193-
- name: Checkout
194-
uses: actions/checkout@v4
195-
196-
- name: Upload static files
197-
uses: actions/upload-pages-artifact@v3
198-
with:
199-
path: .
200-
201-
- name: Deploy to GitHub Pages
202-
id: deployment
203-
uses: actions/deploy-pages@v4
204-
```
164+
### Pages 示例设置(GitHub Pages)
205165

206-
3. 在仓库设置中启用 **Pages**,来源:**GitHub Actions**
166+
1.`template-config.json` 添加到 GitHub 仓库。
167+
2. 删除现有的 `.github/workflows/jekyll-gh-pages.yml`
168+
3.**repositories > Settings > Pages** 中直接创建并配置示例页面。
207169

208170
## 贡献
209171

0 commit comments

Comments
 (0)