northscript.github.io

northscript.github.io

#framework#jekyll#github-pages#gulp#bootstrap#scss
Download

Glixer - GitHub Pages, Gulp, Jekyll, SCSS, Bootstrap.

Blog, Portfolio & Website build system.

Why?

  1. EASY to use and Quick to get started.
  2. Nothing else does this.

People new to web developement and working professionals often do not have the knowledge or time to know which tools they should be using or the know-how to configure them.

This project is meant to be a jump start for people in both groups.

Demo

View this jekyll theme in action here

Built with:

The tools listed above are included with this package and are ready to go once this package is installed.

Getting Started

You have options here. You can either locally develop in which case follow the instructions below for your OS, or you can develop online at c9.io.

C9

  1. Logon to Github
  2. Fork this repository
  3. Copy your fork url e.g. [email protected]:YOURUSERNAME/M-C-C.github.io.git
  4. On c9.io create a new workspace
    • Template: Blank (Ubuntu Logo)
    • Clone from Git: use your fork url here
  5. See Linux Install Instructions

Linux install instructions (For distributions with apt-get)

  1. Open a BASH terminal and navigate to the project folder.
  2. Enter the Following commands (1 command per line):
    make
gulp serve

    Windows

    See Windows-Install.md

Mac OSX

Prerequisites

  1. Node.js
  2. XCode

Install/building instructions

  1. open up a new terminal
  2. Enter the following commands: 
    git clone https://github.com/north-script/north-script.github.io
cd north-script.github.io
make #ignore the errors
sudo apt-get install zlib1g-dev ruby ruby-dev build-essential
npm install #you'll get a big thumbs up if its all good

Operation (On local machines)

  1. Navigate to the project folder using the Terminal, Command Prompt or, PowerShell and run gulp serve. It may seem that the program is hanging but it's not, it's running a web server right on the window! (That means that there's something wrong if it quits by itself)
  2. Click Me!
  3. Modify files in the _src folder and see that your browser reloads automatically!
  4. When you are finished editing and admiring your work, you can terminate the web server by pressing Ctrl-C in the command window

Operation (On C9.io)

  1. In your terminal run gulp serve
  2. Click the "Preview" link on the top.

Project Structure

  • _src: Where all your magic is
    • _app: Fonts, JS, SCSS, etc.
      • fonts: Where you want to store your fonts that you made/downloaded
      • js: JavaScript Files, Vendor is for your JavaScript libraries such as Jquery, Bootstrap, Angular, React, etc.
      • scss: Folder where all of the styling happens, You can divide the files up however you would like.
    • _includes: html snippets for the navbar, footer, etc.
    • _layouts: html site layouts, see front.html for an example
    • _posts: Blog posts, used for blogs.
  • .site: Automatically generated output, not recommended to modify anything here as it will get deleted/overwritten.
  • _config.yml: Jekyll Build Configuration, Don't change this unless you are feeling adventurous or know what you are doing
  • css, fonts, js: Used for Jekyll build. Not recommended to change anything in these folders unless you know what you are doing

Built by

Mike Boardley

Please email me your comments & feedback.

=========

Maintainers

Samuel Brekke

minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog