거의 마크다운만으로 적당히 좋은 느낌의 웹 페이지를 GitHub에 공개한다

GitHub Pages 에서 정적 사이트를 공개 할 때 일부러 html 라든지 쓰지 않고 마크 다운만으로 이케한다는 것을 최근에 알았습니다.

Guthub Pages는 Jekyll 이라는 정적 사이트 생성기를 지원하지만 이 설정을 조금 쓰면 괜찮은 웹 페이지로 게시할 수 있습니다.

하는 방법

준비하는 것

GitHub 리포지토리

_config.yml : 사용하고 싶은 Jekyll 테마를 써 둔다.

index.md : 공개하는 페이지의 톱에 표시하는 페이지.

최소한 이것으로 괜찮습니다.

_config.yml의 내용은

theme: <テーマ名>
title: [<ページタイトル>]
description: [<ページ概要>]

이런 느낌입니다. 서포트되고 있는 테마는 여기 에 실려 있는 것만으로, 이건 에 걸려 있는 테마나 자작 테마는 사용할 수 없는 것 같습니다.

리포지토리 업데이트

준비한 리포지토리에 방금 만든 _config.yml 및 index.md를 푸시합니다.

예로서

theme: jekyll-theme-hacker
title: [テストページ]
description: [サンプル]

↑이런 느낌의 _config.yml

# サンプル

markdown でつくるページ

## 見出し

- 箇条書き1
- 箇条書き2
- 箇条書き3

> 引用

```
const hello = () => {
  return "Hello World!"
}
```

↑ 이런 느낌의 index.md 를 master 브랜치의/docs 이하에 둡니다.

페이지를 공개하고 있지만 GitHub Pages에서는 다음에서 공개 설정을 선택할 수 있습니다.

master 브랜치

master 브랜치의/docs 디렉토리 이하

마크다운만으로 공개하고 싶은 이유가 코드에 대한 문서를 평상시 사용하는 마크다운만으로 좋은 느낌으로 표시할 수 있으면 기쁘기 때문이었으므로, master 브랜치의/docs 디렉토리 이하를 설정합니다.
(덧붙여서 master 브랜치에/docs 디렉토리가 없는 경우, 이 옵션은 선택할 수 없는 것 같습니다.)

외형은



같은 느낌으로 거의 마크다운만으로 Hacker theme 같은 느낌의 페이지를 공개할 수 있었습니다.

다른 파일을 만들어 index.md에서 링크를 붙이는 방법도 일반 마크다운과 같기 때문에 마크다운을 사용하는 사람이라면 특히 곤란하지 않고 좋은 느낌의 web page를 공개할 수 있다고 생각합니다 .