Skip to content

RotemDev/Headstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

97 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Headstart - Make beautiful webpages GitHub license GitHub release jsDelivr Download Gitter Chat

Headstart is a CSS framework.

Features:

  • Brand Colors (Info, Success, Warning, Danger)
  • Responsive, Scalable Grid system
  • Typography
  • Ionicons Icon font
  • Navbars
  • Mobile-first
  • Code views
  • Responsive <img>s
  • Panels, Thumbnails, Cards
  • Custom forms
  • Color palates
  • Carousels
  • CDN / Self-hosting

Install

Note: The files that are currently marked as "SOON" will be added later.

To use jsDelivr's awesome CDN RECCOMMENDED:

<!-- Main CSS File -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/headstart-css/0.3.1/rotem.min.css">
<!-- JS File -->
<script src="SOON"></script>

To use self-hosting:

Download Headstart from here, extract it somewhere in your website, then:

<!-- main css file -->
<link rel="stylesheet" href="path/to/rotem.min.css">
<!-- JS file -->
<script src="SOON"></script>

How to use icons

To use the icons, add a <i> or a <span> with class="ion-XXX" when XXX is the icon name.
For example:

<div class="col-3 success">
  <p><i class="ion-chevron-right"></i> Example</p>
</div>

Versioning

The versioning system for stable releases is MAJOR.MINOR.PATCH (Semantic versioning).

The versioning system for unstable (development) releases (Only from v2) is vMAJORDEV-YEARwWEEKREVISION (For example, the second release for v2 on week 21 of 2017 is v2-17w21b.)

Compile from source

To compile from sources on Linux/macOS (Windows is not supported, and will not be in the future (Note: Cygwin is probably supported, but isn't tested)):

You need to have jdk and ruby-sass installed. To install, Type in the terminal:

$ sudo apt-get install ruby-sass openjdk-8-jdk # Debian-based distros
$ sudo yum install rubygems openjdk-8-jdk && sudo gem install sass # Fedora-based distros
$ sudo pacman -S ruby-sass openjdk-8-jdk # Arch-based distros
$ sudo gem install sass # macOS and other ruby-enabled distros. For JDK, download the corrsponding file from http://www.oracle.com/technetwork/java/javase/downloads/ and follow installation instructions.

On debian-based and arch-based distros, the command will install ruby as well as sass and java. On fedora-based distros, the command will install ruby and java, and then sass. On macOS and other distros with ruby installed, the rubygems package manager will install sass.

Then do:

$ git clone https://github.com/RotemDev/Headstart.git # Clone the repository
$ cd Headstart
$ ./compile # Run the compile script.
$ cat compile.log # (to see the compilation log).

Then, the compiled CSS files and fonts are located at <CLONING_DIR>/css/, and the compiled JS files are at <CLONING_DIR>/js-dist/