Rgitbook: Gitbook for R Markdown

R MarkdownでGitbookを編集する

.Rmdから.mdに変換し、gitbookとして構築できる

> library(Rgitbook)

バージョン: 0.9

一連の手順...

  1. checkForGitbook() # Gitbookがインストールされているかを確認
  2. newGitbook() # 新規gitbook用のディレクトリを用意
  3. SUMMARY.mdを編集
  4. initGitbook() # .Rmdファイルを自動生成
  5. .Rmdファイルを編集
  6. buildRmd() # .Rmd -> .md
  7. buildGitbook()
  8. openGitbook()
  9. publishGitbook()

関数名 概略
Rgitbook-package Gitbook Projects with R Markdown
buildGitbook This will build a gitbook from the source markdown files.
buildRmd Builds markdown files from all Rmarkdown files in the given directories.
checkForGitbook Check if Gitbook is installed.
gitbookInfo Returns the version information about the currently installed gitbook and what is avaialble from .
initGitbook Create files and folders based on contents of SUMMARY.md.
installGitbook This will install Gitbook.io.
newGitbook Initializes a new Gitbook.
openGitbook Open a built gitbook.
publishGitbook Publish the built gitbook to Github.

buildGitbook

.mdからgitbookのためのファイルをビルド

> buildGitbook()

buildRmd

対象ディレクトリ中の.Rmdファイルを.mdに変換する

> buildRmd(dir = getwd(), clean = FALSE, log.dir, log.ext = ".txt", ...)

checkForGitbook

Gitbookがインストールされているかを確認する。

> checkForGitbook()
checking npm
checking gitbook
gitbook is installed and available

gitbookInfo

initGitbook

SUMMARY.mdの内容をもとに.Rmdを自動生成する。上書きする使用なので一度実行したら二度と実行しないほうがよい...

> # initGitbook()

openGitbook

> openGitbook()