Skip to content

sndsgn/tachyons

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TACHYONS

WIP (heavily in flux). More documetation and examples will be coming soon.

Build responsive, performant, and easy to maintain interfaces faster.

Principles

  • Everything should be 100% responsive
  • Everything should be readable on any device
  • Everything should be as performant as possible
  • Designing in the browser should be easy
  • It should be easy to change an interface without breaking any existing interfaces
  • Doing one thing extremely well promotes reusability and reduces repetition

Features

  • Mobile-first css
  • Single-purpose class architecture
  • Optimized for maximum gzip compression
  • Less than 10kb when minified and gzipped
  • Usable across projects
  • Currently built on sass. Will eventually move the main build to rework, but will offer ports for less, sass, stylus, and vanilla css.

Getting started

The easiest way to use tachyons is to include the minified file in the head. You can include the latest, minified version of tachyons by including this in the head of your html file

Include it in a project

<link rel="http://tachyons.io/css/tachyons.min.css">

I will add version controlled cdn hosted options soon.

Modify the source

Set up the project by cloning the repo, navigating into it, and installing the necessary dependencies by running the following commands:

 git clone [email protected]:mrmrs/tachyons.git yourProject
 cd yourProject
 rm -rf .git
 git init
 git add remote [email protected]/yourUserName/yourProject.git
 npm install

You can alternatively fork the repo and clone your own version of it.

To run the development environment

npm start

This will watch the sass directory and do the following on file change:

  • Compile scss files down to css/tachyons.css and css/tachyons.min.css
  • Run autoprefixer on css/tachyons.css (this allows you to keep vendor prefixes out of your source files)
  • Run csslint and print the results to your terminal window
  • Run an instance of browser-sync - this causes any browsers or devices pointing to your local server to reload on file change. It will also keep all browsers in sync with eachother i.e. they will all scroll simultaneously. If you fill out a form on one device all devices will be updated with that content. It's a huge help if you are testing multiple browsers or devices.

Built with Tachyons

Tachyons is built with

License

The MIT License (MIT)

Copyright (c) 2014 @mrmrs

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

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

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 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 THE SOFTWARE.

About

Fully responsive, performance first css patterns

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 98.0%
  • JavaScript 2.0%