Contents

# Github docs

A Jekyll theme for Github styled documentation

### Theme usage

1. To use this theme in your project via `github-pages`, add a _config.yml file with this line
    ```yaml
    remote_theme: boycce/github-docs
    ```

### Theme local preview

1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
    ```ruby
    source '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
    ```
2. Then update `github-pages` and the `theme`
    ```
    $ bundle install // bundle update to refresh gems
    ```
3. And run
    ```
    $ bundle exec jekyll serve
    ```

### Development

1. Install rvm/ruby `^2.7.3` if not having done so already
2. (a) `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
3. (b) `$ bundle install` (install theme deps automatically)
4. `$ jekyll serve --port 4001`

### Publishing Gem

1. `$ gem build github-docs.gemspec`
2. `$ gem push github-docs-*.gem`

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
github-docs-0.0.19	readme.md