File tree Expand file tree Collapse file tree 3 files changed +61
-0
lines changed Expand file tree Collapse file tree 3 files changed +61
-0
lines changed Original file line number Diff line number Diff line change
1
+ # ` build `
2
+
3
+ A lot of the files to build the Tachyons documentation are generated with build scripts.
4
+ All of those scripts and their source contents are found here.
5
+
6
+ There are two primary build pipelines, one for metadata that's shared throughout the site (like the latest Tachyons version or css stats).
7
+ The second for generating component documentation found at [ ` /components ` ] ( https://tachyons.io/components ) .
Original file line number Diff line number Diff line change
1
+ # ` components/t `
2
+
3
+ This is where the components used by the docs site live.
4
+ They have a special directory so they don't get mixed up with the component documentation.
Original file line number Diff line number Diff line change
1
+ # [ TACHYONS] ( https://tachyons.io )
2
+
3
+ Where the documentation lives for < https://tachyons.io > .
4
+
5
+ ### Installation
6
+
7
+ ##### Running the web app
8
+
9
+ ``` sh
10
+ git clone https://github.com/tachyons-css/tachyons-css.github.io
11
+ npm i && npm run dev
12
+ ```
13
+
14
+ ##### Building component documentation
15
+
16
+ Run the build for all components (this will take a while)
17
+
18
+ ``` sh
19
+ npm run build:components
20
+ ```
21
+
22
+ Run the build for a particular component category
23
+
24
+ ``` sh
25
+ npm run build:components lists
26
+ ```
27
+
28
+ ## Related
29
+
30
+ - [ ` tachyons ` ] ( https://github.com/tachyons-css/tachyons )
31
+ - [ ` tachyons-x-ray ` ] ( https://github.com/tachyons-css/tachyons-x-ray )
32
+ - [ ` cssstats ` ] ( https://github.com/cssstats/cssstats )
33
+ - [ ` immutable-css ` ] ( https://github.com/johnotander/immutable-css )
34
+ - [ ` next ` ] ( https://github.com/zeit/next.js )
35
+
36
+ ## License
37
+
38
+ MIT
39
+
40
+ ## Contributing
41
+
42
+ 1 . Fork it
43
+ 2 . Create your feature branch (` git checkout -b my-new-feature ` )
44
+ 3 . Commit your changes (` git commit -am 'Add some feature' ` )
45
+ 4 . Push to the branch (` git push origin my-new-feature ` )
46
+ 5 . Create new Pull Request
47
+
48
+ ***
49
+
50
+ > Made by [ @mrmrs_ ] ( https://twitter.com/mrmrs_ ) , [ @4lpine ] ( https://twitter.com/4lpine ) & contributors
You can’t perform that action at this time.
0 commit comments