📄

MarkdownファイルをGitHub Pagesで公開するテンプレート

2024/11/15に公開

Markdownファイルをとりあえず公開したい

ドラマ相棒の面白い回をメモしていたのをとりあえずウェブ上に公開したくて、以下の記事を参考にしてMarkdownファイルをぱぱっと公開してみました。

http://yoshikyoto.github.io/text/git/gh_pages_md.html

ちなみに公開した相棒のページはこれ。

https://my12parsecs.github.io/aibou/

そして、今後も簡単に作れるようにテンプレートにしておきました。

https://github.com/my12parsecs/md-ghpages

このテンプレートだとどう見えるか。
https://my12parsecs.github.io/md-ghpages/

ディレクトリ構成

├─ _layouts
│  └─ default.html
├─ styles
│  └─ index.css
├─ subpage
│  └─ index.md
├─ index.md
└─ _config.yml
_layouts/default.html
<head>
~
    <title>{{page.title}}</title>
    <meta name="description" content={{page.desc}}>

    <!-- md-ghpagesの部分をレポジトリ名に-->
    <link rel="stylesheet" type="text/css" href="/md-ghpages/styles/index.css">
 
</head>
<body>
    <div>
        {{content}}
    </div>
</body>

index.md
---
layout: default
title: タイトルになる
desc: 説明文になる
---
# Hello World!
これがコンテンツのところに入る
subpage/index.md
---
layout: default
title: タイトルになる
desc: 説明文になる
---
# これがサブページ
フォルダ名がそのままURLのパスになる。
ここではsubpageというフォルダ名なので`https://{ハンドル名}.github.io/{レポジトリ名}/subpage`というURL。

とりあえずWebページとして公開したいMarkdownファイルがあったら使ってみてね。

Discussion