Skip to content

03 DeployToGithubPages

Github Pages へのデプロイ準備

mkdocs new sample01
cd sample01
mkdocs build
mkdocs serve

git init
git remote add origin https://github.com/kakisoft/newRepositoryyyyyyy.git
git pull origin master


※以下、最低1回、コマンドラインで実行しておく。
git add .
git commit -m "first commit"
git push -u origin master

以降、vsCodeから、通常使用できるようになる。

デプロイ

mkdocs gh-deploy


(公開サイトのURLs)
https://kakisoft.github.io/newRepositoryyyyyyy/


※末尾に「.git」は付かないよ。

GitHub Pages の設定などは特に不要。
(勝手に「gh-page」ブランチが、公開設定となる。)
・・・なんだけど、ちゃんと公開されなかったんで、settingでちゃんと設定した方がよさそう。
あと、Proにしないと、Privateリポジトリは公開できないみたい。






作業は、masterブランチで行う。

デプロイコマンド

mkdocs gh-deploy

※ gh-deploy ブランチのページが公開される。

gh-deployブランチに、「site」フォルダが作成される。
(docsフォルダ以下のファイル(mkファイル)は、gh-deployブランチには作成されない。)


以下、勘違いノート。

全部込み(docsファイルの中身とか)で、githubに push

mkdocs serve
mkdocs gh-deploy
⇒push

※ deployのみを実行して pushすると、siteフォルダがクリアされるっぽい。