Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 3.14 KB

README.md

File metadata and controls

59 lines (38 loc) · 3.14 KB

Tachyons Bootstrap

GitHub Workflow Status codecov.io contributions welcome Hit Count

View & use Tachyons bootstrap: tachyons-bootstrap.dwyl.com

Why?

We need to make it easy for people to ship :shipit: as consistently, quickly and painlessly as possible. To aid that we need a component guide with detailed examples people can "copy-paste" from.

Tachyons Bootstrap has been built to demonstrate the power of tachyons and functional css and encourage people to understand the code they're implementing. To learn more about tachyons and why we think it's great, check out: https://github.com/dwyl/learn-tachyons#why-tachyons

What?

Tachyons Bootstrap is inspired by Bootstrap v3 (an excellent, comprehensive and reusable set of components). It's a component guide built using tachyons that people can use to build/ship their apps fast.

How?

Display component examples alongside their code, so people can copy and paste to replicate them.

Still to come

  • Create a Tutorial Blog Post for how tachyons bootstrap was made.
  • Share the blog and our intro videos with the public!

Using Tachyons Bootstrap

Find the Tachyons Bootstrap guide at: https://tachyons-bootstrap.dwyl.com/

To use it in your own project:

  • Simply add <link rel="stylesheet" href="https://unpkg.com/[email protected]/css/tachyons.min.css"/> to the head of your html file to give you access to tachyons classes.
  • Copy the component code that you wish to use from the guide.
  • Enjoy your new components and make them your own! 🎉

Running this repo

If you wish to run this repo locally, clone it and enter:

npm start into the command line

and navigate to localhost:8000 in your browser.

NB - you don't need to run this repo to use Tachyons Bootstrap in your project, this is just an option for people who may wish to explore this repo from a technical perspective or add to it.

All dwyl projects & products use the "PETE" Stack, which includes tachyons.