Skip to content

Commit

Permalink
ci: migrate to GitHub Actions & feat: default to wide skin
Browse files Browse the repository at this point in the history
  • Loading branch information
finalchild committed Jan 6, 2024
1 parent fd2a821 commit 6cf4bdb
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 25 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: deploy

on:
push:
branches:
- main
workflow_dispatch: {}

permissions:
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- run: npm install
- run: npm run-script generate
- uses: actions/configure-pages@v4
- uses: actions/upload-pages-artifact@v3
with:
path: './generated'
- id: deployment
uses: actions/deploy-pages@v4
13 changes: 0 additions & 13 deletions .travis.yml

This file was deleted.

8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@
## 기본 설정
1. 이 저장소에서 <kbd><samp>Use this template</samp></kbd> 버튼을 누릅니다.
2. `markcafe-config.json`에서 `imgSrcPrefix``"https://<페이지 루트 URL>/"`로 설정합니다.<br>예) `https://finalchild.github.io/my-tutorial/`
3. (트라비스 CI를 사용한 적이 없다면) [트라비스 CI](https://travis-ci.com/)에 접속하여, 깃허브로 로그인하여 계정을 활성화합니다.
4. [깃허브 도움말](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)을 참고하여 깃허브 계정의 개인 접근 토큰을 생성합니다. 공개 저장소의 경우에는 `public_repo`, 비공개 저장소의 경우에는 `repo` 권한이 필요합니다.
5. 트라비스 CI의 저장소 설정 페이지에서 `GITHUB_TOKEN` 환경 변수의 값을 생성한 개인 접근 토큰으로 설정합니다.
6. (와이드 스킨 카페의 경우) `style.css`에서 `.container``width``100%`로 설정합니다.
3. 저장소 설정 페이지에서 `Pages``Source``GitHub Actions`로 설정합니다.

## 사용
### `markcafe-config.json`
Expand All @@ -20,7 +17,6 @@
* `imagesDirectoryPath`: 사용되는 이미지가 들어 있는 디렉터리의 경로를 지정합니다.
* `cssPath`: CSS 파일의 경로를 지정합니다.
* `generatedDirectoryPath`: 변환 목적지 디렉터리의 경로를 지정합니다.
* `cname`: 깃허브 페이지에 사용자 지정 도메인을 사용할 때, `CNAME` 파일에 들어갈 내용을 지정합니다. 비어 있으면 `CNAME` 파일을 생성하지 않습니다.
* `markdownItOptions`: [Markdown-It](https://markdown-it.github.io/)에 전달되는 설정 객체입니다.
* `imgSrcPrefix`: `![]()` 구문으로 이미지를 삽입할 때, 경로가 문자열 `images/`로 시작하면 그 앞에 설정된 문자열을 더합니다. 이미지를 절대 경로로 바꾸어 네이버 카페에 HTML을 바로 붙여넣을 수 있게 하는 용도입니다.
* `tipHeaderContent`: 아래에서 설명하는 팁 구문을 사용할 때, 팁의 헤더에 삽입되는 HTML을 설정합니다.
Expand Down Expand Up @@ -56,7 +52,7 @@
`npm run-script generate` 명령어를 실행합니다. 변환된 파일은 `generated` 디렉터리에 저장됩니다.

### CI
트라비스 CI가 활성화되어 있으면 커밋이 푸시될 때 빌드 후 깃허브 페이지에 `generated` 디렉터리를 자동으로 업로드합니다. 깃허브 페이지가 `gh-pages` 브랜치를 사용하도록 설정해 주세요.
깃허브 액션스가 활성화되어 있으면 커밋이 푸시될 때 빌드 후 깃허브 페이지에 `generated` 디렉터리를 자동으로 업로드합니다. 페이지가 깃허브 엑션스를 사용하도록 설정해 주세요.

### 실행 결과
`generated` 디렉터리의 `<파일명>.html`에 미리보기 페이지가, `<파일명>.html.txt`에 네이버 카페에 붙여넣을 수 있는 HTML이 저장됩니다.
Expand Down
1 change: 0 additions & 1 deletion markcafe-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"imagesDirectoryPath": "./images",
"cssPath": "./style.css",
"generatedDirectoryPath": "./generated",
"cname": "",
"markdownItOptions": {
"html": true,
"breaks": true,
Expand Down
3 changes: 0 additions & 3 deletions markcafe.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ async function main() {

const promises = [];
promises.push(fse.copy(config.imagesDirectoryPath, path.join(config.generatedDirectoryPath, 'images')));
if (typeof config.cname === 'string' && config.cname !== '') {
promises.push(fs.writeFile(path.join(config.generatedDirectoryPath, 'CNAME'), config.cname + '\n'));
}
promises.push((async () => {
const css = await fs.readFile(config.cssPath, 'utf8');

Expand Down
4 changes: 2 additions & 2 deletions style.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.container {
width: 90%;
width: 100%;
margin: 0.5em auto 0.5em;
}

Expand Down Expand Up @@ -54,7 +54,7 @@ th {
}

td {
padding-left: 0.9em;
padding-left: 0.9em;
}

th.p27 {
Expand Down

0 comments on commit 6cf4bdb

Please sign in to comment.