Skip to content

TOOLSREQ-9155: Theme Update and Modernization #44

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

Draft
wants to merge 5 commits into
base: gh-pages
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# This .gitignore is appropriate for repositories deployed to GitHub Pages and using
# a Gemfile as specified at https://github.com/github/pages-gem#conventional

# Basic Jekyll gitignores (synchronize to Jekyll.gitignore)
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata

# Additional Ruby/bundler ignore for when you run: bundle install
/vendor

# Specific ignore for GitHub Pages
# GitHub Pages will always use its own deployed version of pages-gem
# This means GitHub Pages will NOT use your Gemfile.lock and therefore it is
# counterproductive to check this file into the repository.
# Details at https://github.com/github/pages-gem/issues/768
Gemfile.lock
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.3.6
37 changes: 37 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
# gem "jekyll", "~> 4.3.3"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!


group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
gem 'jekyll-asciidoc'
gem "just-the-docs"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# Production Resources

The gh-pages branch of this repo is home for the files used to generate http://oreillymedia.github.io/production-resources/.
The `gh-pages` branch of this repo is home for the files used to generate http://oreillymedia.github.io/production-resources/.

The web page content is generated from markdown source (well, actually it's kramdown) using Jekyll. For details, see GitHub notes about GitHub Pages and then check out Jekyll documentation. After that, reverse engineer and Google.
The web page content is generated from markdown source (well, actually it's kramdown) using Jekyll.

## Local Preview

You can preview the files locally using `jekyll`. Clone down the repo and make sure you have the proper version of Ruby installed on your system by checking the _.ruby-version_ file. You can use [`rbenv`](https://github.com/rbenv/rbenv) to manage Ruby on your system.

Then install the Gem dependencies:

```
bundle install
```

Then change the base URL in the _\_config.yml_ file to:

```
baseurl: /oreillymedia.github.io/production-resources/
```

Finally, start your local server:

```
bundle exec jekyll serve
```

This should show output including the server address which will be something like: `http://127.0.0.1:4000/oreillymedia.github.io/production-resources/`. Open that URL in a browser to see how the docs will look.
6 changes: 6 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
name: O'Reilly Production
markdown: kramdown
baseurl: http://oreillymedia.github.io/production-resources/

# Build settings
theme: just-the-docs
color_scheme: orm-colors
search_enabled: true
heading_anchors: true
23 changes: 0 additions & 23 deletions _layouts/default.html

This file was deleted.

1 change: 1 addition & 0 deletions _sass/color_schemes/orm-colors.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$link-color: #d3002d;
58 changes: 58 additions & 0 deletions _sass/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.nowrap {
white-space: nowrap;
}

.hide {
display:none;
}

.implementation_notes {
text-align:right;
color: $link-color;
margin-bottom: 0;
padding: 5px 36px 5px 0;
position: relative;
svg {
position: absolute;
right:0;
bottom:1px;
width: 2rem;
height: 2rem;
padding: .5rem;
transform: rotate(90deg);
}
svg.active {
transform: rotate(-90deg);
}
&:hover {
svg {
background-color: #f5f6fa;
}
}

}
.implementation_notes_container td {
border-right: 1px solid $link-color;
}


h4 {
color: $link-color;
}
.main-content h4 {
margin-top: 3em;
}

.eol {
color: #3d3b49;
}

.deprecated {
color: $link-color;
text-decoration: line-through;
}

.main-content dl, dd, dt {
display: block;
text-align: left ! important;
}
Loading