jekyll-theme-conscious-sedation

Demo

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes and your sass in _sass. To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

More information can be found in the Resources and Credits section.

Directory File Structure

  • _data

    • menu.yml
      • menu items for the top bar navigation.
    • socialmedia.yml
      • Social media information for the footer.

  • _drafts

    • A place for unpublished posts.

  • _includes

    • articles_main.html
      • The number of posts to show and where the layout file is.
    • article_post.html
      • The layout for posts.
    • google-analytics.html
      • Google anaylytic script.
    • header.html
      • Top navigation bar.
    • head.html
      • Typical head with cdn link for google fonts, font-awesome, and links for google-analytics, seo, and feed.
    • footer.html
      • Footer with social links and cdnjs for Foundation.

  • _layouts

    • default.html
      • This file is the main layout of your site. It adds the head, header, content, and footer.
    • home.html
      • This file links to _layouts/default.html, and adds the "Welcome" callout. The _includes/articles_main.html adds the posts formatted by _includes/article_post.html
    • page.html
      • A layout that only adds a title section.
    • post.html
      • The layout for your posts.

  • _posts

    • The home for your published posts.

  • _site

    • Do not touch. This is your generated site.

  • _sass

    • The following files or partials contain vanilla css.
    • conscious-sedation.scss
      • This is the file that collects all the partials. The cdnjs for Foundation. Any unused partials can be disabled by adding // before the @import.
      • _rouge-github.scss
      • _tags.scss
      • _footer.scss
      • _grid.scss
      • _settings.scss
      • _menu.scss
      • _calloutcard.scss
      • _button.scss
      • _badge.scss
      • _breadcrumbs.scss
      • _forms.scss
      • _pagination.scss
      • _table.scss
      • _tabs.scss
      • _tooltip.scss

  • assets

    • main.scss
      • This file imports the sass files into a single style sheet.
    • SoftGrunge1.jpg -- Wallpapers by Carol Francis
      • SoftGrunge2.jpg
      • SoftGrunge3.jpg
      • SoftGrunge4.jpg
      • SoftGrunge5.jpg

  • feed.xml

    • This file will be automatically generated by the jekyll-feed plugin.

  • README.md

    • Documentation

  • index.html

    • Homepage for your site. It is blank on purpose and changes should be made in _layouts/home.html.

  • sample.html

    • This page shows off some Foundation features, and can be removed.

  • about.md

    • An about page formated by _layouts/page.html

  • categories.html

    • categories tag page formated at _layout/page.html

  • tags.html

    • tag page that gets it layout from _layouts/default.html

  • _config.yml

    • This is your Jekyll configuration file and your Jekyll server will need to be restarted to see any changes. You will want to personalize this.

  • Gemfile

    • A place to add gems.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-conscious-sedation"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-conscious-sedation

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-conscious-sedation

To locate files run 'bundle show jekyll-theme-conscious-sedation' and copy then copy any files over that you may need.

You can also Fork, Download, or Clone the theme.

Resources and Credits

This theme was created with the Foundation 6 framework, and fonts by Font Awesome and Google Fonts. Color scheme was created using Coolors, Paletton, and Cohesive Colors.

Anything from Foundation Sites and Building Blocks can be used, though additional JS may be needed.

The theme is bundled with Jekyll 3.5. For more information on Jekyll visit jekyllrb.com for front matter, or writing posts, using drafts and creating pages.

More information on the following gems can be found at Ruby Gems.

  • Jekyll-feed 0.9.2 to generate an Atom feed of your posts.
  • Jekyll-seo-tag 2.2.3 to add metadata tags for search engines and social networks.
  • Jekyll-sitemap 1.1.1 to automatically generate a sitemap.xml for your site.
  • Jekyll-mentions 1.2.0 adds @mention support.
  • Jemoji 0.8.0 adds Github emoji images.

This theme was inspired by Gravity and Codinfox.

Footer from Dynda. Tags and Categories from Codinfox and M-x Kelsin.

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll 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.

When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

The theme is available as open source under the terms of the MIT License.