Github docs¶ ↑
A Jekyll theme for Github styled documentation
Theme usage¶ ↑
-
To use this theme in your project via
github-pages
, add a _config.yml file with this lineremote_theme: boycce/github-docs
Theme preview¶ ↑
-
To preview this theme in your project via
github-pages
, add a Gemfile in your root folder# (old) # source 'https://rubygems.org' # gem 'github-pages', group: :jekyll_plugins # Below pulls the latest remote_theme in development # https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages source 'https://rubygems.org' gem "github-docs", git: "https://github.com/boycce/github-docs" group :jekyll_plugins do gem "jekyll-remote-theme", "~> 0.4.2" end
-
Then update
github-pages
and thetheme
$ bundle install // or bundle update
-
And run
$ bundle exec jekyll serve
Development¶ ↑
-
Install rvm/ruby
^2.7.3
if not having done so already -
(a)
$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag
(not sudo, or.…) -
(b)
$ bundle install
(install theme deps automatically) -
$ jekyll serve
Publishing Gem¶ ↑
-
$ gem build github-docs.gemspec
-
$ gem push github-docs-*.gem