Skip to content
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

Add pixyll.gemspec #334

Closed
wants to merge 9 commits into from
Closed

Add pixyll.gemspec #334

wants to merge 9 commits into from

Conversation

ashawley
Copy link
Collaborator

@ashawley ashawley commented Jun 4, 2017

See #333 for the consequences of making a Gem.

I'm suggesting the first version of the Gem will be 2.9.0, since the last release tag in git is 2.8.0.

According to my analysis of building the site with master and this PR, the only change is where the CSS file is located:

$ git checkout master
$ bundle install
$ bundle exec jekyll b
$ mv _site _site~
$ git checkout ashawley/gemspec
$ bundle install
$ bundle exec jekyll b
$ diff -ur _site~ _site

ashawley/pixyll-site@master...gemspec

The rest of the changes are whitespace-only changes.

@ashawley
Copy link
Collaborator Author

ashawley commented Jun 5, 2017

Here are the contents of the gem at this point:

$ gem contents pixyll
.../pixyll-2.9.0/LICENSE.txt
.../pixyll-2.9.0/README.md
.../pixyll-2.9.0/_includes/ajaxify_content_form.html
.../pixyll-2.9.0/_includes/footer.html
.../pixyll-2.9.0/_includes/head.html
.../pixyll-2.9.0/_includes/header.html
.../pixyll-2.9.0/_includes/navigation.html
.../pixyll-2.9.0/_includes/pagination.html
.../pixyll-2.9.0/_includes/post_footer.html
.../pixyll-2.9.0/_includes/share_buttons.html
.../pixyll-2.9.0/_includes/social_links.html
.../pixyll-2.9.0/_layouts/center.html
.../pixyll-2.9.0/_layouts/default.html
.../pixyll-2.9.0/_layouts/home.html
.../pixyll-2.9.0/_layouts/page.html
.../pixyll-2.9.0/_layouts/post.html
.../pixyll-2.9.0/_sass/_animations.scss
.../pixyll-2.9.0/_sass/_base.scss
.../pixyll-2.9.0/_sass/_basscss.scss
.../pixyll-2.9.0/_sass/_blockquotes.scss
.../pixyll-2.9.0/_sass/_clearfix.scss
.../pixyll-2.9.0/_sass/_code.scss
.../pixyll-2.9.0/_sass/_footer.scss
.../pixyll-2.9.0/_sass/_forms.scss
.../pixyll-2.9.0/_sass/_gists.scss
.../pixyll-2.9.0/_sass/_header.scss
.../pixyll-2.9.0/_sass/_links.scss
.../pixyll-2.9.0/_sass/_measure.scss
.../pixyll-2.9.0/_sass/_media-queries.scss
.../pixyll-2.9.0/_sass/_pagination.scss
.../pixyll-2.9.0/_sass/_positions.scss
.../pixyll-2.9.0/_sass/_posts.scss
.../pixyll-2.9.0/_sass/_social-icons.scss
.../pixyll-2.9.0/_sass/_tables.scss
.../pixyll-2.9.0/_sass/_typography.scss
.../pixyll-2.9.0/_sass/_variables.scss
.../pixyll-2.9.0/_sass/basscss/_base-buttons.scss
.../pixyll-2.9.0/_sass/basscss/_base-forms.scss
.../pixyll-2.9.0/_sass/basscss/_base-reset.scss
.../pixyll-2.9.0/_sass/basscss/_base-typography.scss
.../pixyll-2.9.0/_sass/basscss/_buttons-blue.scss
.../pixyll-2.9.0/_sass/basscss/_color-base.scss
.../pixyll-2.9.0/_sass/basscss/_colors.scss
.../pixyll-2.9.0/_sass/basscss/_syntax-highlighting.scss
.../pixyll-2.9.0/_sass/basscss/_utility-headings.scss
.../pixyll-2.9.0/_sass/basscss/_utility-typography.scss
.../pixyll-2.9.0/_sass/basscss/_utility-white-space.scss
.../pixyll-2.9.0/assets/css/main.scss

@ashawley
Copy link
Collaborator Author

ashawley commented Jul 6, 2017

The site navigation changes were separated and moved to #342

README.md Outdated
Then, add this line to your Jekyll site:

```yaml
theme: minima
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be pixyll, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, sorry. Good catch. Fixed.

@johno
Copy link
Owner

johno commented Jul 6, 2017

This is awesome!

@ashawley ashawley force-pushed the gemspec branch 2 times, most recently from d95cf7f to c0f7d06 Compare July 6, 2017 19:30
@ashawley ashawley mentioned this pull request Jul 7, 2017
21 tasks
# A simple Ruby Gem to bootstrap dependencies for setting up and
# maintaining a local Jekyll environment in sync with GitHub Pages
# https://github.com/github/pages-gem
gemspec
gem 'github-pages'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider moving this to gemspec file as an runtime dependency if it's needed. That is in the Rubygem's doc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't find it was necessary to add github-pages as a runtime dependency. I also felt it wasn't necessary. Github-pages brings in a lot of unnecessary gems as dependencies, including other themes. See the list of dependencies on it's gem page:

https://rubygems.org/gems/github-pages

Pixyll is such a minimal theme, that it seemed like overkill bringing in all these dependencies.

However, if you find there are dependencies from github-pages gem that should be included for Pixll, then let me know.

I still keep the github-pages gem in the Gemfile only to maintain Pixyll's official site on GitHub, and for people who want to continue to use pixyll as a fork, rather than as a jekyll theme/gem.

This is a good question, and I meant to explain this.

@johno
Copy link
Owner

johno commented Nov 3, 2017

Hey @ashawley, I don't have the time right now to look into the gem implementation, but I've just invited you to become a contributor on the repo. I trust you to get the gem working without breaking backwards compatibility. If/when you publish to ruby gems, though, please also add me as an owner.

@ashawley
Copy link
Collaborator Author

ashawley commented Nov 3, 2017

I've discovered we'll need to consider some breaking changes to support the gem format:

  • Moving template in index.html to _layouts/home.html
  • Move css/pixyll.scss to assets/css/main.scss

To avoid breaking compatability, maybe introduce the gem in a new major version? 3.0? Maybe keep developing 2.x series as master in git, and create a new git branch called 3.x or some such.

I tried the theme externally from the repo, reviewed the served site more carefully and noticed other issues. For example, there are references in site.text in the pagination.html include file. I'm sure there are other configs and includes to consider. We'd need to either drop those configs, or document this about the gem in the README.

Anyway, still some more work needed on this.

The good news is it would be not a problem to add you as an owner of the gem:

http://guides.rubygems.org/command-reference/#gem-owner

@ashawley ashawley force-pushed the gemspec branch 3 times, most recently from ae3b009 to 408c128 Compare November 3, 2017 19:18
@claudiuconstantin
Copy link

Any progress?

@ashawley ashawley mentioned this pull request Dec 3, 2018
@ashawley ashawley force-pushed the gemspec branch 3 times, most recently from 0bdf3b3 to de2af26 Compare December 14, 2018 02:38
@ashawley ashawley added this to the 3.0 milestone Jan 26, 2019
@ashawley
Copy link
Collaborator Author

ashawley commented Feb 5, 2019

Scorching the earth and starting over in a new PR. Please, stand by...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants