Functional css for humans

css design design-patterns design-systems design-tools frontend functional-css html responsive

Find a file

mrmrs 862d2cc0b5 Add compiled css		2016-11-15 11:33:31 +00:00
css	Add compiled css	2016-11-15 11:33:31 +00:00
src	Move aspect ratios out of utilities	2016-11-15 11:32:56 +00:00
.gitignore	Add .swp to the .gitignore	2015-10-23 15:56:35 -06:00
bower.json	Add bower config	2016-06-30 13:54:56 +01:00
code-of-conduct.md	Add code of conduct.	2016-04-27 17:32:20 +01:00
index.html	Add blank html file that references tachyons css	2016-03-22 20:16:17 +00:00
license	Nuke docs code, use tachyons-cli	2015-10-23 16:03:52 -06:00
package.json	Bumping package number.	2016-11-15 11:32:22 +00:00
readme.md	Add seanoshea.me to list of sites	2016-11-05 12:57:40 -04:00

readme.md

TACHYONS

Functional css for humans.

Quickly build and design new UI without writing css.

Principles

Everything should be 100% responsive
Everything should be readable on any device
Everything should be as fast as possible
Designing in the browser should be easy
It should be easy to change any interface or part of an interface without breaking any existing interfaces
Doing one thing extremely well promotes reusability and reduces repetition
Documentation helps promote reusability and shared knowledge
Css is global. Html is not. Send the smallest amount of code to the user as possible.

Features

Mobile-first css architecture
490 accessible color combinations
8px baseline grid
Multiple debugging utilities to reduce layout struggles
Single-purpose class structure
Optimized for maximum gzip compression
Lightweight (~13kB)
Usable across projects
Growing open source component library
Works well with plain html, react, ember, angular, rails, and more
Infinitely nestable responsive grid system
Built with Postcss

Getting started

Docs can be found at http://tachyons.io/docs The modules are generally pretty small and thus quick and easy to read.

Use the CDN

The quickest and easiest way to start using tachyons is to include a reference to the minified file in the head of your html file.

Currently the latest version is 4.5.4

<link rel="stylesheet" href="https://unpkg.com/tachyons@4.5.4/css/tachyons.min.css">

You can always grab the latest version with

<link rel="stylesheet" href="https://unpkg.com/tachyons/css/tachyons.min.css">

Local Setup

Clone the repo from github and install dependencies through npm.

git clone https://github.com/tachyons-css/tachyons.git
cd tachyons
npm install

Dev

If you want to just use everything in tachyons/src as a jumping off point and edit all the code yourself, you can compile all of your wonderful changes by running

npm start

This will output both minified and unminified versions of the css to the css directory.

If you want to recompile everything from src everytime you save a change - you can run the following command, which will compile and minify the css

npm run build:watch

If you want to check that a class hasn't been redefined or 'mutated' there is a linter to check that all of the classes have only been defined once. This can be useful if you are using another library or have written some of your own css and want to make sure there are no naming collisions. To do this run the command

npm run mutations

Contributing

Please read our code of conduct for contributors.

Websites that Use Tachyons

(if you have a project that uses Tachyons feel free to make a PR to add it to this list)

And of course...

http://tachyons.io

Help

If you have a question or need help feel free to open an issue here or jump into the Tachyons slack channel.

License

MIT