R MarkdownからRStudioおよびrmarkdown
パッケージの機能を用いてGitHub Pagesにサイトを構築する。RStudioの標準機能でビルドも容易に行うことができる。
10.5 rmarkdown’s site generator | R Markdown: The Definitive Guide
最近はblogdown
パッケージを用いてGo言語でできたHugoというフレームワークを使って構築するのが流行りのようだが、操作が煩雑なこと、TOCをfloatにできなかったりするので単純な方法で着手する。いずれにせよコンテンツとしてはR Markdownないし素のMarkdownで作成しているため移行は簡単なはず。rmarkdown
による方法ではXXX.Rmd
からbaseurl/XXX.html
が生成され、blogdown
ではbaseurl/XXX/index.html
(index.htmlは省略可)の形になるという違いがある。
test section for TOC float
blogdown
ではなく標準のrmarkdown
パッケージによるhtml作成の利点として、出力がblogdown::html_page
ではなく標準のhtml_document
なために普段と同様のオプション設定がそのまま通ることがある。特にblogdown
でTOC_floatが通らないのは痛く、やはりブログ向けであってドキュメントの記載には向かない模様。
3.1 HTML document | R Markdown: The Definitive Guide
上記を参照に設定していく。サイト全体のオプションについては_site.yml
の終わりの方に記載している。
Bootswatch: Free themes for Bootstrapから選択してtheme: readable
のように記載すれば良い。
index.htmlでTOCを表示しないようにしたければ、index.Rmdのymlに
output:
html_document:
toc: false
としてやるだけで良い。
_site.yml
で出力先をdocs/
にしていれば、レポジトリの設定から選んでセーブするだけ。Descriptionのところにもアドレスを入れておくと良い。
knitr::include_graphics("img/GitHub-PagesSetting.png")