Functional css for humans

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

Find a file

John Otander 5be59c1701 Fix the build and bump to the latest cli version In order to ensure that the build doesn't cause a bug in the .grow selector I've temporarily removed trimTrailingZeros. This will be added back once I get a fix in to the perfectionist library. *** Related ben-eb/perfectionist#42 Closes #261		2016-09-19 18:17:42 -06:00
css	Fix the build and bump to the latest cli version	2016-09-19 18:17:42 -06:00
src	Fix typo in widths for two-thirds	2016-09-17 19:04:46 +01: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	Fix the build and bump to the latest cli version	2016-09-19 18:17:42 -06:00
readme.md	Update readme	2016-09-17 19:08:08 +01: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 performant 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
css is global. HTML is not. Send the smallest amount of code to the user as possible.

Features

Mobile-first css
Single-purpose class structure
Optimized for maximum gzip compression
~13kB when minified and gzipped
Usable across projects
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 easy to read and grock if you're familiar with css at all.

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.1

<link rel="stylesheet" href="https://unpkg.com/tachyons@4.5.1/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

Build

First time

Tachyons is available as a series of small self contained css modules. They aren't dependent on eachother but are designed to play well together. But tachyons is also just css. And you should feel free to edit css that is in your project. The first time you build tachyons all of the css gets installed via npm, but the modules then get copied over to your local src directory and then the tachyons-cli uses a series of postcss plugins to compile the source down to vanilla css.

Updating

If you want to update a tachyons partial, install the desired module version via npm and run the build command again. Note this will copy over all source files, so if you've modified src/ your changes might will be overwritten but you can use version control (like git!) to undo these changes.

npm run build

Dev

If you want to just use 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

If you want to make a PR to change part of the css source for tachyons, make sure you make the PR on the corresponding module that can be found in the tachyons org. Those modules get copied into the main repo so any changes you make to the css in this repo would get overridden.

Also 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 feel free to open an issue here or jump into the Tachyons slack channel.

License

MIT