Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 2.82 KB

README.md

File metadata and controls

82 lines (51 loc) · 2.82 KB
Raw

n# Quick Start

Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at http://yourgithubusername.github.io - if not, give it ten minutes as GitHub suggests and it'll appear soon

There are 3 different ways that you can make changes to your blog's files:

  1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
  2. Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
  3. Clone down your repository and make updates locally, then push them to your GitHub repository.

_config.yml

Jekyll Now Features

✓ Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
✓ Fully responsive and mobile optimized base theme (Theme Demo)
✓ Sass/Coffeescript support using Jekyll 2.0
✓ Free hosting on your GitHub Pages user site
✓ Markdown blogging
✓ Syntax highlighting
✓ Disqus commenting
✓ Google Analytics integration
✓ SVG social icons for your footer
✓ 3 http requests, including your avatar

✘ No installing dependancies
✘ No need to set up local development
✘ No configuring plugins
✘ No need to spend time on theming
✘ More time to code other things ... wait ✓!

Credits

  • Jekyll - Thanks to its creators, contributors and maintainers.
  • SVG icons - Thanks, Neil Orange Peel. They're beautiful.

Build and test locally

install node, node package manager and grunt

Install nvm (node version mananger)

install node.js with "nvm install node"

install npm (package manager), is installed with node.

install grunt with

'npm install grunt-cli' in the directory of the project

Use this guide for an existing project:

Existing Grunt project

'sudo apt install ruby-dev'

Ruby

Downgraded to ruby 2.7.2 because of persistent errors with 3.0.

Install the gems

'sudo gem install bundle jekyll'

Run Jekyll locally with 'bundle exec jekyll serve'

To Do

As of October 20, 2016

  • Get a good pwa -icon sized 192x192

  • Get a nice logo

  • check twitter feed and rss feed

  • move fb og into production, change app_id in Yaml

  • fixed fb scrape, now need to improve og tags

  • supply a favicon.ico or favicon in a rel link