Skip to content

Commit

Permalink
Merge pull request #54 from oreillymedia/ATLAS-503-remove-jekyll
Browse files Browse the repository at this point in the history
ATLAS-503: Strip Out jekyll Functionality
  • Loading branch information
nadamsoreilly authored Jan 12, 2023
2 parents bb6047f + 92445ae commit 2d7f1e6
Show file tree
Hide file tree
Showing 35 changed files with 12 additions and 3,465 deletions.
20 changes: 1 addition & 19 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
source 'https://rubygems.org'
ruby '2.7.6'
ruby '2.7.7'

# Specify your gem's dependencies in atlas_assets.gemspec
gemspec

gem "rake", "~> 13.0.0"
gem "jekyll", "~> 3.0"
gem "sass"
gem "jekyll-assets", "~> 2.0.0"
gem "coffee-script", "~> 2.4.1"
gem 'rack-contrib'
gem "rack-rewrite"
gem "pygmentize", "~> 0.0.3"
gem "kramdown"
gem "coderay", "~> 1.1.3"
gem "puma", "~> 4.3.11"
gem "eco", "~> 1.0.0"
gem "sprockets"
gem "liquid"
gem "rack", "~> 2.1.4"
gem "kramdown-parser-gfm"
gem "kramdown-syntax-coderay"
109 changes: 5 additions & 104 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,133 +1,34 @@
PATH
remote: .
specs:
atlas_assets (0.8.14)
atlas_assets (0.9.0)
handlebars_assets (= 0.23.1)

GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
coderay (1.1.3)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0)
concurrent-ruby (1.1.10)
eco (1.0.0)
coffee-script
eco-source
execjs
eco-source (1.1.0.rc.1)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
execjs (2.8.1)
fastimage (1.8.1)
addressable (~> 2.3, >= 2.3.5)
ffi (1.15.5)
forwardable-extended (2.6.0)
handlebars_assets (0.23.1)
execjs (~> 2.0)
multi_json (~> 1.0)
sprockets (>= 2.0.0)
tilt (>= 1.2)
http_parser.rb (0.8.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.9.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (>= 1.17, < 3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-assets (2.0.3)
fastimage (~> 1.8)
jekyll (~> 3.0)
sprockets (~> 3.3)
sprockets-helpers (~> 1.2)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
kramdown-syntax-coderay (1.0.1)
coderay (~> 1.1)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
multi_json (1.15.0)
nio4r (2.5.8)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.0)
puma (4.3.12)
nio4r (~> 2.0)
pygmentize (0.0.3)
rack (2.1.4.1)
rack-contrib (2.3.0)
rack (~> 2.0)
rack-rewrite (1.5.1)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.30.0)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sprockets (3.7.2)
rack (3.0.3)
sprockets (4.2.0)
concurrent-ruby (~> 1.0)
rack (> 1, < 3)
sprockets-helpers (1.4.0)
sprockets (>= 2.2)
rack (>= 2.2.4, < 4)
tilt (2.0.11)

PLATFORMS
ruby

DEPENDENCIES
atlas_assets!
coderay (~> 1.1.3)
coffee-script (~> 2.4.1)
eco (~> 1.0.0)
jekyll (~> 3.0)
jekyll-assets (~> 2.0.0)
kramdown
kramdown-parser-gfm
kramdown-syntax-coderay
liquid
puma (~> 4.3.11)
pygmentize (~> 0.0.3)
rack (~> 2.1.4)
rack-contrib
rack-rewrite
rake (~> 13.0.0)
sass
sprockets

RUBY VERSION
ruby 2.7.6p219
ruby 2.7.7p221

BUNDLED WITH
2.3.26
1 change: 0 additions & 1 deletion Procfile

This file was deleted.

3 changes: 0 additions & 3 deletions Procfile.dev

This file was deleted.

58 changes: 1 addition & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,4 @@
Atlas Assets
============

This Ruby gem holds all shared assets used throughout the O'Reilly Atlas platform.

Style Guide
-----------

For reference, visit the online [style guide documentation](http://atlas-assets.herokuapp.com) included in this gem.

Usage
-----

To use in a new Rails application, add the gem to your Gemfile, and add the following to your CSS (`app/assets/stylesheets/application.css`) and JS (`app/assets/javascripts/application.js`) manifest files.

```javascript
*= require atlas_assets
```

Along with all the CSS and JS widgets, it will include our base bundle of JS libraries (`JQuery`, `underscore.js`, `backbone.js`, etc). It will also set up a number of JS namespaces `window.classes`, `window.app`, `window.events` and `window.constants`, so make sure to include the JS manifest before any of your JS code.

If you need to, you can import individual stylesheets from this gem in your application:

```css
@import "atlas_assets/icons";
```

Local Development
-----------------

To get started on your own machine first install the required gems with bundler"

```
bundle install
```

Then to run the site and watch for changes run:

```
foreman start -f Procfile.dev
```

This will launch the jekyll command as well as a second script to watch for changes to stylesheets and write those changes to `docs/ignore` to trigger rebuilds from jekyll. That folder is ignored by git and can be safely deleted.

Adding new styles
-----------------

If you need to add or change styles in this gem, first get a local environment set up:

1. Clone down the gem to your local machine
2. Run `bundle` from the gem root
3. Fire up jekyll by running `jekyll serve --watch`

You now have the site running in your browser on `localhost:4000`. Now follow these steps to add and document the new style(s):

1. Create you own feature branch
2. Implement your style by tweaking the CSS and checking the documentation on `localhost:4000`. Do not work from the specific Atlas Rails app by updating the gem constantly. All new styles should be developed using the `docs`, and should be independent from a particular application.
3. When ready, bump the version number in `lib/atlas_assets/version.rb`, run `bundle update` and send a pull request to the master branch.
4. When the pull request has been accepted, we'll publish the gem by running `gem build atlas_assets.gemspec` and `gem push [NAME].gem`.
5. Bump the `atlas_assets` gem version in your apps `Gemfile`, run `bundle`, and use the new styles.
This Ruby gem holds JavaScript and CSS assets used on the O'Reilly Atlas platform.
16 changes: 0 additions & 16 deletions Rakefile

This file was deleted.

14 changes: 0 additions & 14 deletions _config.yml

This file was deleted.

9 changes: 4 additions & 5 deletions atlas_assets.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ require 'atlas_assets/version'
Gem::Specification.new do |gem|
gem.name = "atlas_assets"
gem.version = Atlas::Assets::VERSION
gem.authors = ["Rune Skjoldborg Madsen"]
gem.email = ["rune@runemadsen.com"]
gem.description = %q{Public repository with assets and design guide for the Atlas platform}
gem.summary = %q{Public repository with assets and design guide for the Atlas platform}
gem.homepage = "http://atlas-assets.herokuapp.com"
gem.authors = ["O'Reilly Tools Team"]
gem.email = ["toolsreq@oreilly.com"]
gem.description = %q{Public repository with assets for the Atlas platform}
gem.summary = %q{Public repository with assets for the Atlas platform}

gem.files = `git ls-files`.split($/)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
Expand Down
9 changes: 0 additions & 9 deletions config.ru

This file was deleted.

1 change: 0 additions & 1 deletion docs/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion docs/404.html

This file was deleted.

72 changes: 0 additions & 72 deletions docs/_layouts/default.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_plugins/jekyll_assets.rb

This file was deleted.

Loading

0 comments on commit 2d7f1e6

Please sign in to comment.