Repository files navigation

Basically Basic is aJekyll theme meant asa substitute for the default ---Minima.Conventions and features found there are fully supported byBasically Basic,with a few enhancements thrown in for good measure:

• Clean responsive design withsix customizable skins
• Curriculum Vitæ/Resume layout powered byJSON data
• About page layout
• Disqus Comments and Google Analytics support
• SEO best practices viaJekyll SEO Tag

1. Installation
   1. Ruby Gem Method
   2. GitHub Pages Compatible Method
      1. Remove the Unnecessary
2. Structure
   1. Starting Fresh
   2. Starting from jekyll new
3. Configuration
   1. Skin
   2. Google Fonts
   3. Text
   4. Navigation
   5. Pagination
   6. Author
   7. Reading Time
   8. Comments (via Disqus)
   9. Google Analytics
4. Layouts
   1. Default
   2. Post
   3. Page
   4. Home
   5. About
   6. Curriculum Vitæ/Resume
5. Customization
   1. Overriding Includes and Layouts
   2. Customizing Sass (SCSS)
   3. Customizing JavaScript
   4. SVG Icons
   5. Customizing Sidebar Content
6. Development
7. Contributing
   1. Pull Requests
8. Credits

If you're running Jekyll v3.3+ and self-hosting you can quickly install thetheme as Ruby gem. If you're hosting with GitHub Pages you'll have to use the"repo fork" method or directly copy all of the theme files (seestructure below) into your project.

1. Install the theme as a Ruby Gem by adding it to yourGemfile like so:

   gem"jekyll-theme-basically-basic"

2. Fetch and update your bundled gems by running the followingBundler command:

   bundle

3. Set thetheme in your project's Jekyll configuration,_config.yml:

   theme:jekyll-theme-basically-basic

Fork theBasically Basic repo,then rename it toUSERNAME.github.io --- replacingUSERNAME with yourGitHub username.

Note: Your Jekyll site should be viewable immediately athttp://USERNAME.github.io. If it's not, you can force a rebuild byconfiguring your site (see below for more details).

Replace the contents ofGemfile found in the root of your Jekyll site withthe following:

source"https://rubygems.org"gem"github-pages",group::jekyll_plugins

Then runbundle update and verify that theGitHub Pages gemand its dependencies install properly.

If you forked or downloaded thejekyll-theme-basically-basic repo you cansafely remove the following files and folders:

• .codeclimate.yml
• .editorconfig
• .gitattributes
• .github
• .scss-lint.yml
• CHANGELOG.md
• jekyll-theme-basically-basic.gemspec
• LICENSE.md
• Rakefile
• README.md
• screenshot.png
• /docs
• /example

Layouts, includes, Sass partials, and data files are all placed in their defaultlocations. Stylesheets and scripts inassets, and a few development relatedfiles in the project's root directory.

Please note: If you installed Basically Basic via the Ruby Gem method, themefiles found in/_layouts,/_includes,/_sass, and/assets will bemissing. This is normal as they are bundled with thejekyll-theme-basically-basic gem.

jekyll-theme-basically-basic├── _data# data files|  └── theme.yml# theme settings and custom text├── _includes# theme includes and SVG icons├── _layouts# theme layouts (see below for details)├── _sass# Sass partials├── assets|  ├── javascripts||  └── main.js|  └── stylesheets|     └── main.scss├── _config.yml# sample configuration└── index.md# sample home page (all posts/not paginated)

After creating aGemfile and installing the theme you'll need to add and editthe following files:

• _config.yml
• /_data/theme.yml
• index.md

Note: Consult thepagination documentation below forinstructions on how to enable it for the home page.

Using thejekyll new command will get you up and running the quickest.

Edit_config.yml and create_data/theme.yml as instructed above and you'regood to go.

Configuration of site-wide elements (lang,title,description,logo,author, etc.) happens in your project's_config.yml. See theexample configuration in this repo for additionalreference.

For more configuration options be sure to consult the documentation for:jekyll-seo-tag,jekyll-feed,jekyll-paginate, andjekyll-sitemap.

This theme comes in six different skins (color variations). To change skins addone of the following to your/_data/theme.yml file:

skin: default	skin: night	skin: plum

skin: sea	skin: soft	skin: steel

This theme allows you to easily useGoogle Fontsthroughout the theme. Simply add the following to your/_data/theme.yml, replacing the fontname andweightsaccordingly.

google_fonts:  -name:"Fira Sans"weights:"400,400i,600,600i"  -name:"Fira Sans Condensed"

To change text found throughout the theme add the following to your/_data/theme.yml file and customize as necessary.

t:skip_links:"Skip links"skip_primary_nav:"Skip to primary navigation"skip_content:"Skip to content"skip_footer:"Skip to footer"menu:"Menu"home:"Home"newer:"Newer"older:"Older"email:"Email"subscribe:"Subscribe"read_more:"Read More"posts:"Posts"page:"Page"of:"of"min_read:"min read"present:"Present"

By default all internal pages with atitle will be added to the "off-canvas"menu. For more granular control and sorting of these menu links:

1. Create a custom list to override the default setting by adding anavigation_pages array to your/_data/theme.yml file.

2. Add raw page paths in the order you'd like:

   navigation_pages:  -about.md  -cv.md

Each menu link's title and URL will be populated based on theirtitle andpermalink respectively.

Break up the main listing of posts into smaller lists and display them overmultiple pages byenabling pagination.

1. Include thejekyll-paginate plugin in yourGemfile.

   group:jekyll_pluginsdogem"jekyll-paginate"end

2. Addjekyll-paginate togems array in your_config.yml file and thefollowing pagination settings:

   paginate:5# amount of posts to show per pagepaginate_path:/page:num/

3. Createindex.html (or renameindex.md) in the root of your project andadd the following front matter:

   layout:homepaginate:true

Author information is used as meta data for post "by lines" and propagates thecreator field of Twitter summary cards with the following front matter in_config.yml:

author:name:John Doetwitter:johndoetwitterpicture:/assets/images/johndoe.png

Site-wide author information can be overridden in a document's front matter inthe same way:

author:name:Jane Doetwitter:janedoetwitterpicture:/assets/images/janedoe.png

Or by specifying a corresponding key in the document's front matter, thatexists insite.data.authors. E.g., you have the following in the document'sfront matter:

author:megaman

And you have the following in_data/authors.yml:

megaman:name:Mega Mantwitter:megamantwitterpicture:/assets/images/megaman.pngdrlight:name:Dr. Lighttwitter:drlighttwitterpicture:/assets/images/drlight.png

Currentlyauthor.picture is only used inlayout: about. Recommended size is300 x 300 pixels.

To enable reading time counts addread_time: true to a post or page's YAMLFront Matter.

Optionally, if you have aDisqus account, you can show acomments section below each post.

To enable Disqus comments, add yourDisqus shortname to your project's_config.yml file:

disqus:shortname:my_disqus_shortname

Comments are enabled by default and will only appear in production when builtwith the followingenvironment value:JEKYLL_ENV=production

If you don't want to display comments for a particular post you can disablethem by addingcomments: false to that post's front matter.

To enable Google Analytics, add yourtracking IDto_config.yml like so:

google_analytics:UA-NNNNNNNN-N

Similar to comments, the Google Analytics tracking script will only appear inproduction when using the following environment value:JEKYLL_ENV=production.

This theme provides the following layouts, which you can use by setting thelayoutFront Matter on each page,like so:

---layout:name---

This layout handles all of the basic page scaffolding placing the page contentbetween the masthead and footer elements. All other layouts inherit this oneand provide additional styling and features inside of the{{ content }} block.

This layout accommodates the following front matter:

# optional alternate title to replace page.title at the top of the pagealt_title:"Basically Basic"# optional sub-title below the page titlesub_title:"The name says it all"# optional intro text below titles, Markdown allowedintroduction:|    Basically Basic is a Jekyll theme meant to be a substitute for the default --- [Minima](https://github.com/jekyll/minima). Conventions and features found in Minima are fully supported by **Basically Basic**.# optional call to action linksactions:  -label:"Learn More"icon:github# references name of svg icon, see full list belowurl:"http://url-goes-here.com"  -label:"Download"icon:download# references name of svg icon, see full list belowurl:"http://url-goes-here.com"image:# URL to a hero image associated with the post (e.g., /assets/page-pic.jpg)# post specific author data if different from what is set in _config.ymlauthor:name:John Doetwitter:johndoetwittercomments:false# disable comments on this post

Visually this layout looks and acts the same aslayout: post, with two minordifferences.

• Author "by line" and publish date are omitted.
• Disqus comments are omitted.

This layout accommodates the same front matter aslayout: page, with theaddition of the following:

paginate:true# enables pagination loop, see section above for additional setup

This layout accommodates the same front matter aslayout: page, with theaddition of the following to display an author picture:

author:name:John Doepicture:/assets/images/johndoe.png

Recommendedpicture size is approximately300 x 300 pixels. Ifauthorobject is not explicitly set in the about page's front matter the themewill default to the value set in_config.yml.

If blank there no image will appear.

This layout accommodates the same front matter aslayout: page. Itleverages aJSON-based file standard forresume data to conveniently render a curriculum vitæ or resume painlessly.

Simply use JSON Resume'sin-browser resume builderto export a JSON file and save to your project as_data/cv.json.

The default structure, style, and scripts of this theme can be overridden andcustomized in the following two ways.

Theme defaults can beoverriddenby placing a file with the same name into your project's_includes or_layouts directory. For instance:

• To specify a custom style path or meta data to the_includes/head.htmlfile, create an_includes directory in your project, copy_includes/head.html from Basically Basic's gem folder to<your_project>/_includes and start editing that file.

ProTip: to locate the theme's files on your computer runbundle show jekyll-theme-basically-basic. This returns the location of thegem-based theme files.

To override the defaultSass (located in theme's_sass directory), do one of the following:

1. Copy directly from the Basically Basic gem

   • Go to your local Basically Basic gem installation directory (runbundle show jekyll-theme-basically-basic to get the path to it).
   • Copy the contents of/assets/stylesheets/main.scss from there to<your_project>.
   • Customize what you want inside<your_project>/assets/stylesheets/main.scss.

2. Copy from this repo.

   • Copy the contents ofassets/stylesheets/main.scssto<your_project>.
   • Customize what you want inside<your_project/assets/stylesheets/main.scss.

Note: To make more extensive changes and customize the Sass partials bundledin the gem. You will need to copy the complete contents the_sass directory to<your_project> due to the way Jekyll currently reads those files.

To make basic tweaks to theme's style Sass variables can be overridden by addingto<your_project>/assets/stylesheets/main.scss. For instance, to change theaccent color used throughout the theme add:

$accent-color:red;

Before any@import lines.

To override the default JavaScript bundled in the theme, do one of the following:

1. Copy directly from the Basically Basic gem

   • Go to your local Basically Basic gem installation directory (runbundle show jekyll-theme-basically-basic to get the path to it).
   • Copy the contents of/assets/javascripts/main.js from there to<your_project>.
   • Customize what you want inside<your_project>/assets/javascripts/main.js.

2. Copy from this repo.

   • Copy the contents ofassets/javascripts/main.jsto<your_project>.
   • Customize what you want inside<your_project>/assets/javascripts/main.js.

The theme uses social network logos and other iconography saved as SVGs forperformance and flexibility. Said SVGs are located in the_includes directoryand prefixed withicon-. Each icon has been sized and designed to fit a16 x 16 viewbox and optimized withSVGO.

Icon	Filename
	icon-arrow-left.svg
	icon-arrow-right.svg
	icon-bitbucket.svg
	icon-calendar.svg
	icon-codepen.svg
	icon-download.svg
	icon-dribbble.svg
	icon-email.svg
	icon-facebook.svg
	icon-flickr.svg
	icon-github.svg
	icon-gitlab.svg
	icon-googleplus.svg
	icon-instagram.svg
	icon-lastfm.svg
	icon-linkedin.svg
	icon-pdf.svg
	icon-pinterest.svg
	icon-rss.svg
	icon-soundcloud.svg
	icon-stackoverflow.svg
	icon-stopwatch.svg
	icon-tumblr.svg
	icon-twitter.svg
	icon-xing.svg
	icon-youtube.svg

Fill colors are defined in the_sass/basically-basic/_icons.scss partial andset with.icon-name where class name matches the corresponding icon.

For example the Twitter icon is given a fill color of#1da1f2 like so:

<spanclass="icon icon--twitter">{% include icon-twitter.svg %}</span>

Alongside the SVG assets, there are icon helper includes to aid in generatingsocial network links.

For example, the followingicon-github.html include:

{%includeicon-github.htmlusername=jekylllabel='GitHub' %}

Will output the following HTML:

<ahref="https://github.com/jekyll"><spanclass="icon icon--github"><svgviewBox="0 0 16 16"xmlns="http://www.w3.org/2000/svg"fill-rule="evenodd"clip-rule="evenodd"stroke-linejoin="round"stroke-miterlimit="1.414"><pathd="M8 0C3.58 0 0 3.582 0 8c0 3.535 2.292 6.533 5.47 7.59.4.075.547-.172.547-.385 0-.19-.007-.693-.01-1.36-2.226.483-2.695-1.073-2.695-1.073-.364-.924-.89-1.17-.89-1.17-.725-.496.056-.486.056-.486.803.056 1.225.824 1.225.824.714 1.223 1.873.87 2.33.665.072-.517.278-.87.507-1.07-1.777-.2-3.644-.888-3.644-3.953 0-.873.31-1.587.823-2.147-.09-.202-.36-1.015.07-2.117 0 0 .67-.215 2.2.82.64-.178 1.32-.266 2-.27.68.004 1.36.092 2 .27 1.52-1.035 2.19-.82 2.19-.82.43 1.102.16 1.915.08 2.117.51.56.82 1.274.82 2.147 0 3.073-1.87 3.75-3.65 3.947.28.24.54.73.54 1.48 0 1.07-.01 1.93-.01 2.19 0 .21.14.46.55.38C13.71 14.53 16 11.53 16 8c0-4.418-3.582-8-8-8"></path></svg></span><spanclass="label">GitHub</span></a>

To set up your environment to develop this theme:

1. Clone this repo
2. cd into/example and runbundle install.

To test the theme the locally as you make changes to it:

1. cd into the root folder of the repo (e.g.jekyll-theme-basically-basic).
2. Runbundle exec rake preview and open your browser tohttp://localhost:4000/example/.

This starts a Jekyll server using the theme's files and contents of theexample/ directory. As modifications are made, refresh your browser to seeany changes.

Found a typo in the documentation? Interested in adding a feature orfixing a bug? Then by all meanssubmit an issue or take astab at submitting apull request. If this is your firstpull request, it may be helpful to read up on theGitHub Flow.

When submitting a pull request:

1. Clone the repo.
2. Create a branch off ofmaster and give it a meaningful name (e.g.my-awesome-new-feature) and describe the feature or fix.
3. Open a pull request on GitHub.

Sample pages can be found in the/docs and/examplefolders if you'd like to tackle any "low-hanging fruit" like fixing typos, badgrammar, etc.

Michael Rose

• https://mademistakes.com
• https://twitter.com/mmistakes
• https://github.com/mmistakes

• Simple Icons
• Noun Project
• Unsplash

• Jekyll
• Susy
• Breakpoint

The MIT License (MIT)

Copyright (c) 2017 Michael Rose

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.