A Jekyll theme for Github styled documentation
github-pages
, add a _config.yml file with this lineremote_theme: boycce/github-docs
To preview this theme for your project, add the following Gemfile in your root folder
source 'https://rubygems.org'
# Use one of the following:
# 1. simulate github-pages
gem 'github-pages', group: :jekyll_plugins
# 2. Or use jekyll-remote-theme, contains unsupported dependency versions, e.g. Sass issues
# https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages
# gem "github-docs", git: "https://github.com/boycce/github-docs"
# group :jekyll_plugins do
# gem "jekyll-remote-theme", "~> 0.4.2"
# end
Install or update dependencies
$ bundle install // or bundle update
And run (github-pages pulls the latest remote_theme)
$ bundle exec jekyll serve
^2.7.3
if not having done so already$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag
(not sudo, or....)$ bundle install
(install theme deps automatically)$ jekyll serve --port 4001
$ gem build github-docs.gemspec
$ gem push github-docs-*.gem
or$ rm ./*.gem 2>/dev/null && gem build github-docs.gemspec && gem push github-docs-*.gem