Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use gh-pages for publishing vignettes #8

Closed
vsimko opened this issue Oct 15, 2017 · 1 comment
Closed

use gh-pages for publishing vignettes #8

vsimko opened this issue Oct 15, 2017 · 1 comment
Assignees

Comments

@vsimko
Copy link
Owner

vsimko commented Oct 15, 2017

related links:

@vsimko vsimko self-assigned this Oct 15, 2017
@vsimko
Copy link
Owner Author

vsimko commented Oct 15, 2017

Here is how I did it:

  • created empty gh-pages branch (branched from initial commit)
  • added this branch as a git submodule into vignettes/gh-pages
> git submodule add -b gh-pages https://github.com/vsimko/rroad.git vignettes/gh-pages
  • added Gemfile to gh-pages with the following content:
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
  • added _config.yml and selected the theme
  • now, I was able to build the page locally using jekyll serve
  • I created script vignettes/publish.sh which copies Rmd file over to gh-pages and uses knitr to build the index.md markdown file, which is served by github pages as a website.

@vsimko vsimko closed this as completed Oct 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant