A Jekyll theme for Github styled documentation
- To use this theme in your project via
github-pages, add a _config.yml file with this lineremote_theme: boycce/github-docs
- To preview this theme in your project via
github-pages, add a Gemfile in your root foldersource 'https://rubygems.org' # (old) # gem 'github-pages', group: :jekyll_plugins # Below pulls the latest remote_theme in development (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
- Then update
github-pagesand thetheme$ bundle install // bundle update to refresh gems - And run
$ bundle exec jekyll serve
- Install rvm/ruby
^2.7.3if 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 --port 4001
$ gem build github-docs.gemspec$ gem push github-docs-*.gemor$ rm ./*.gem 2>/dev/null && gem build github-docs.gemspec && gem push github-docs-*.gem