artin/tachyons
1
0
Fork 0
mirror of https://github.com/tachyons-css/tachyons.git synced 2026-02-06 11:36:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removing config for hologram and updating README.

Browse Source
This commit is contained in:
mrmrs 2014-10-17 15:02:48 -07:00
parent 2a398855f0
commit 3ee36f641d
2 changed files with 19 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -14,8 +14,27 @@ Build responsive, performant, and easy to maintain interfaces faster.
* 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:
```
@ -33,7 +52,6 @@ You can alternatively fork the repo and clone your own version of it.
```
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)

25
hologram_config.yml
View File

@ -1,25 +0,0 @@
# Hologram will run from same directory where this config file resides
# All paths should be relative to there
# The directory containing the source files to parse recursively
source: ./components
# The directory that hologram will build to
destination: ./docs
# The assets needed to build the docs (includes header.html,
# footer.html, etc)
# You may put doc related assets here too: images, css, etc.
documentation_assets: ./doc_assets
# Any other asset folders that need to be copied to the destination
# folder. Typically this will include the css that you are trying to
# document. May also include additional folders as needed.
#dependencies:
# - ./build
# Mark which category should be the index page
# Alternatively, you may have an index.md in the documentation assets
# folder instead of specifying this config.
index: navigation