dunders 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5270796b457ba1b9db8a34e804d314ee8eff28
-  data.tar.gz: b1027d0ec5104c8ea5692597c348c31c45aa51a4
+  metadata.gz: 51122661ad1a9d781360524a66f024c301cef89a
+  data.tar.gz: 5ca1a1b59e23390b484f9e8c8a29f8f193259eee
 SHA512:
-  metadata.gz: 669ddab9cbb3dd6220bed64b681b4d39db090f5e601bb526c75b9cc771940a04b8f14985c4abcd542ff95e5a762c8b964bc3ce8977dc52fdad77da8ffb25fec7
-  data.tar.gz: c7f1befd7499639a2dbaf99e4de2ec0276712124873ca75c582615d8f21af6d80eec5c991ede5c316c392164cc7128a184665e2e20b2233731c6c32366dc1b30
+  metadata.gz: 3243584926742f1bd4a30d64f6b09cc0be7b3c0c486daac57b5c461a7e4ba6f53a2141f8a5d12f2442c3df6b4afb65af0d5e97dd226dc527f6256f0b2a02c60b
+  data.tar.gz: eb5446879e226c2fee64a77d7a9ba7c98d1f324bc55a00c3578c37db28a8f3e485cbaac9391117216e738d1e8f592c457d18d6561511b7b2d0fe0d0ab341f204

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 William Oliveira
+Copyright (c) 2016 - present William Oliveira <w.oliveira542@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,46 +1,237 @@
-# __s [![Gem Version](https://badge.fury.io/rb/dunders.svg)](https://badge.fury.io/rb/dunders)
+<p align="center">
+    <img src="/assets/images/icons/favicon-96x96.png" alt="Dunders logo">
+</p>
 
-__s, or dunders, is a simple Jekyll Starter Theme.
+# __s
+
+__s, or dunders, is a clean Jekyll Starter Theme.
 
 *The name of this project is a tribute to [Underscores](https://github.com/automattic/_s) project.*
 
-## Installation
+## What a hell is dunder?
+
+Dunder is [double underscore](https://wiki.python.org/moin/DunderAlias), used in Python codes.
+
+## [Demo](https://woliveiras.com.br/dunders.demo/)
+
+## Why I create Dunders?
+
+Whenever I search for a Jekyll Theme I found some project with [Bootstrap](http://getbootstrap.com/), [jQuery](https://jquery.com/) or a structure of theme a little disorganized. I dont like disorder. :/
+
+CSS files with several lines of code. HTML not semantic or JavaScript not very good.
+
+This saddens me.
+
+Because this, I made this scaffold to themes Jekyll!!!
+
+Don't have CSS, don't have JS, and the HTML is clean to you add your structure. Is very basic structure, easy to change.
+
+Use your imagination to build a awesome sites with Dunders.
+
+## Who should use Dunders
+
+Dunders is for people who want to create themes from zero with a simple initial structure.
+
+Use if you want to implement:
+
+- BEMCSS
+- Atomic
+- SMACSS
+- SVG
+- Structured Data (Schema.org)
+- etc
+
+It's for you to release your imagination.
+
+## How to use
+
+Make a folder of your new awesome Jekyll Theme.
+
+Eg.:
 
-Add this line to your Jekyll site's Gemfile:
+```
+mkdir demo
+```
+
+Enter on theme folder and clone this repo.
 
-```ruby
-gem "dunders"
+```
+git clone git@github.com:woliveiras/__s.git .
 ```
 
-And add this line to your Jekyll site:
+Run Bundle, to install dependencies:
 
-```yaml
-theme: dunders
+```
+bundle
 ```
 
-And then execute:
+Up the Jekyll Server:
 
-    $ bundle
+```
+jekyll s
+```
 
-Or install it yourself as:
+And open `localhost:4000` on Browser.
 
-    $ gem install dunders
+Now, make your GREAT THEME!!! :raised_hands:
 
-## Usage
+## Creating draft, posts, pages, publish and unpublish
 
-TODO: Write usage instructions here. Describe available layouts, includes, and/or sass.
+The __s use a plugin named [jekyll-compose](https://github.com/jekyll/jekyll-compose), this serves to make our life easier at the time of creation of posts, pages and publish our posts.
 
-## Contributing
+To use, is simple:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/woliveiras/__s/. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Listed in help you will see new commands available to you:
 
-## Development
+```
+draft      # Creates a new draft post with the given NAME
+post       # Creates a new post with the given NAME
+publish    # Moves a draft into the _posts directory and sets the date
+unpublish  # Moves a post back into the _drafts directory
+page       # Creates a new page with the given NAME
+```
+
+Create your new page using:
 
-To set up your environment to develop this theme, run `bundle install`.
+```
+$ bundle exec jekyll page "My New Page"
+```
+
+Create your new post using:
+
+```
+$ bundle exec jekyll post "My New Post"
+```
 
-You theme is setup just like a normal Jelyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+Create your new draft using:
 
-When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
+```
+$ bundle exec jekyll draft "My new draft"
+```
+
+Publish your draft using:
+
+```
+$ bundle exec jekyll publish _drafts/my-new-draft.md
+# or specify a specific date on which to publish it
+$ bundle exec jekyll publish _drafts/my-new-draft.md --date 2014-01-24
+```
+
+Unpublish your post using:
+
+```
+$ bundle exec jekyll unpublish _posts/2014-01-24-my-new-draft.md
+```
+
+## Structure proposed with Dunders (isn't mandatory)
+
+**assets**
+
+Folder to your images or css or js.
+
+**_includes**
+
+Some partials of site structure.
+
+- **comments.html:** Disqus partial
+- **footer.html:** the footer of site
+- **head.html:** head of html document
+- **header.html:** the header of site
+- **navigation-menu.html:** a example of navigation menu
+- **pagination.html:** simple pagination to show posts (if you are making a Blog theme)
+
+**_layouts**
+
+The scaffolding of Jekyll structure.
+
+Look [here](https://jekyllrb.com/docs/themes/#layouts-and-includes) for more info of these files.
+
+**_sass**
+
+If you like [Sass](sass-lang.com) writes your styles on this folder!
+
+**Other files**
+
+- **about.md:** about you (or user) page
+- **archive.html:** posts archive page
+- **categories.html:** post categories page
+- **tags.html:** tags page, like a categories or archive pages
+- **CNAME:** very important for use custom domain on GitHub, look [here](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)
+- **_config.yml:** Theme configuration file, look Dunders Configuration section
+- **contact.html:** contact page using formspree.io to send messages
+- **index.html:** the index of site
+- **robots.txt:** very important for SEO, look [here](http://www.robotstxt.org/robotstxt.html)
+- **screenshot.png:** use this to show a screenshot of your theme on theme sites such as [jekylthemes.org](http://jekyllthemes.org/)
+
+## How to write posts
+
+Follow the Jekyll workflow: https://jekyllrb.com/docs/posts/
+
+## Dunders configuration
+
+The Jekyll theme is configured by _config.yml file.
+
+It is very important that you configure carefully this file changing the lines for your necessities:
+
+```
+# Site settings
+
+title: Dunders | A Starter Theme for Jekyll # put your blog title
+description: Faster to start a new Jekyll theme # put your description for your amazing blog
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site e.g. https://woliveiras.com.br
+language: "" # language to set into html tag, default is en
+paginate: 5 # Number of posts on each page
+paginate_path: "/page/:num" # links format for pagination
+date_format: "%b %-d, %Y"  # dateformat of reading list, post date, and more
+permalink: /:title/ # use to url friendly
+timezone:  # timezone to show in yout sire
+display-author-front-page: # True if you need show author name and site on home page
+display-author-post-page: true # Very usual for guest posts and the infos of author are writen in header of post.md, by default show infos of user settings
+
+# Useful for translating into other languages.
+
+var_on_the_web: On the web
+var_read: Continue...
+var_newer: Newers
+var_older: Olders
+var_next_post: Next
+var_previous_post: Previous
+var_less_than_a_minute_read: < 1 min read
+var_min_read: min read # Text after reading time. Example: 5 min read.
+var_post_by: Writed by
+var_guest_post_by: Guest post by
+var_your_email: Your mail
+var_your_message: Your message
+var_page_indicator: Page
+var_page_indicator_separator: of
+
+# User settings
+
+author: dunders # put your name or a name of principal author of site/blog
+email: dunders@dunders.com
+twitter_username: dunders
+github_username:  dunders
+gplus_username:  dunders
+disqus_shortname: dunders-website
+
+# Navigation menu
+links:
+  - title: Home
+    url: /
+  - title: About Me
+    url: /about
+  - title: Archive
+    url: /archive
+  - title: Contact
+    url: /contact
+  - title: Categories
+    url: /categories
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/woliveiras/__s/. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/_includes/head.html

@@ -1,9 +1,11 @@
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
   <meta name="description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
   <link rel="author" href="https://plus.google.com/{{ site.gplus_username }}?rel=author">
+  <link rel="stylesheet" href="/css/styles.css">
   <meta name="twitter:card" content="summary_large_image">
   <meta name="twitter:site" content="@{{ site.twitter_username }}">
   <meta name="twitter:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}">

data/_includes/pagination.html

@@ -1,15 +1,15 @@
 <div>
   <ul>
     {% if paginator.previous_page %}
-      <li><a href="{{ paginator.previous_page_path }}">{{ site.var_previous_post }}</a></li>
+      <li><a href="{{ paginator.previous_page_path }}" rel="prev">{{ site.var_previous_post }}</a></li>
     {% else %}
       <li><span>{{ site.var_previous_post }}</span></li>
     {% endif %}
     <li><span>{{ site.var_page_indicator }} {{  paginator.page }} {{ site.var_page_indicator_separator }} {{ paginator.total_pages }}</span></li>
     {% if paginator.next_page %}
-      <li><a href="{{ paginator.next_page_path }}">{{ site.var_next_post }}</a></li>
+      <li><a href="{{ paginator.next_page_path }}" rel="next">{{ site.var_next_post }}</a></li>
     {% else %}
       <li><span>{{ site.var_next_post }}</span></li>
     {% endif %}
   </ul>
-</div>
+</div>

data/_sass/module.sass

@@ -0,0 +1 @@
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dunders
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
-- woliveiras
+- William Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 'A starter theme for Jekyll, based on Underscores for WordPress. Look
-  the project page for more informations: https://github.com/woliveiras/__s'
+description: A starter theme for Jekyll, based on Underscores for WordPress
 email:
 - w.oliveira542@gmail.com
 executables: []
@@ -62,7 +61,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- _config.yml
 - _includes/comments.html
 - _includes/footer.html
 - _includes/head.html
@@ -72,7 +70,7 @@ files:
 - _layouts/default.html
 - _layouts/page.html
 - _layouts/post.html
-- _sass/main.sass
+- _sass/module.sass
 - about.md
 - archive.html
 - assets/images/dunders.png
@@ -120,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A starter theme for Jekyll

data/_config.yml

@@ -1,69 +0,0 @@
-# Site settings
-
-title: Dunders | A Starter Theme for Jekyll # put your blog title
-description: Faster to start a new Jekyll theme # put your description for your amazing blog
-baseurl: "" # the subpath of your site, e.g. /blog
-url: "" # the base hostname & protocol for your site e.g. https://woliveiras.com.br
-language: "" # language to set into html tag, default is en
-paginate: 5 # Number of posts on each page
-paginate_path: "/page/:num" # links format for pagination
-date_format: "%b %-d, %Y"  # dateformat of reading list, post date, and more
-timezone:  # timezone to show in yout sire
-display-author-front-page: # True if you need show author name and site on home page
-display-author-post-page: true # Very usual for guest posts and the infos of author are writen in header of post.md, by default show infos of user settings
-
-# Useful for translating into other languages.
-
-var_on_the_web: On the web
-var_read: Continue...
-var_newer: Newers
-var_older: Olders
-var_next_post: Next
-var_previous_post: Previous
-var_less_than_a_minute_read: < 1 min read
-var_min_read: min read # Text after reading time. Example: 5 min read.
-var_post_by: Writed by
-var_guest_post_by: Guest post by
-var_your_email: Your mail
-var_your_message: Your message
-var_page_indicator: Page
-var_page_indicator_separator: of
-
-# User settings
-
-author: dunders # put your name or a name of principal author of site/blog
-email: dunders@dunders.com
-twitter_username: dunders
-github_username:  dunders
-gplus_username:  dunders
-disqus_shortname: dunders-website
-
-# Navigation menu
-links:
-  - title: Home
-    url: /
-  - title: About Me
-    url: /about
-  - title: Archive
-    url: /archive
-  - title: Contact
-    url: /contact
-  - title: Categories
-    url: /categories
-
-# Build settings
-
-markdown: kramdown
-highlighter: rouge
-permalink: /:title/
-sitemap: true # Generate sitemap.xml
-feed:
-  path: atom.xml
-
-## For more settings: https://jekyllrb.com/docs/configuration/
-
-# exclude files if no need build
-exclude: ['package.json', 'node_modules', 'README.md', 'LICENSE']
-
-# Gems
-gems: [jekyll-paginate, jekyll-sitemap, jekyll-feed]

data/_sass/main.sass

@@ -1 +0,0 @@
-// Silence is golden