Buoy Symptomcss: Styles from A-Z

Customized CSS styles for Symptom A-Z pages. Based off Tachyons library. Tachyons Docs can be found at http://tachyons.io/docs.

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 shouldn't impede accessibility or the default functionality of Html
• You should send the smallest possible amount of code to the user

Getting started

Working between two repositories is quite easy! Follow these steps if you need to modify any CSS.

1. Clone the repo from github and install dependencies through npm.

git clone https://github.com/misscs/symptomcss.git
cd symptomcss
npm install

2. Create a local link. This is the sauce that allows you to seemlessly work with local packages.

npm link

3. Naviagate to Symptom A-Z repo and add new link

npm link @buoy/symptomcss

Dev

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 and watch the src directory for changes. It's aliased to the command:

npm run build:watch

If you'd like to just build the css once without watching the src directory run

npm run build

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

Releasing new version

@todo

Debugging

If you need access to full tachyons library, include a reference to the minified file in the head of your html file.

You can always grab the latest version with

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

You can also specify a specific version. The latest version is 4.9.0

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

Docs

The tachyons docs located at http://tachyons.io are all open source and located at https://github.com/tachyons-css/tachyons-css.github.io

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

License

MIT