tachyons/docs
2018-03-24 11:57:41 -06:00
..
addons Add tachyons-opacity-responsive docs 2018-03-12 23:07:48 -06:00
build Move static generated json files to data dir 2018-03-24 11:57:41 -06:00
components Move over all components 2018-03-23 13:33:55 -06:00
data Move static generated json files to data dir 2018-03-24 11:57:41 -06:00
elements Spike in most of content wrapper changes 2018-03-12 17:15:58 -06:00
grid Spike in most of content wrapper changes 2018-03-12 17:15:58 -06:00
layout Add more references to widths docs 2018-03-13 07:21:17 -06:00
pages Move static generated json files to data dir 2018-03-24 11:57:41 -06:00
themes Updates to display and border radius docs 2018-03-12 23:42:12 -06:00
typography More typography documentation. There will be some variation from the original to clean up broken links and or make things easier to read now that they see all the html that generates the example 2018-03-17 23:10:06 -06:00
ui Move static generated json files to data dir 2018-03-24 11:57:41 -06:00
.gitignore Ignore component loader in module build 2018-03-23 13:36:27 -06:00
class-naming.md Fix typos 2018-03-23 14:46:38 -06:00
faq.md Add James Greig's WIP FAQ 2018-03-07 11:30:28 -07:00
features.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
generator.md Add elements docs 2018-03-07 09:40:44 -07:00
getting-started.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
installation.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
introduction.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
next.config.js Implement basic source file generation 2018-03-23 13:36:27 -06:00
package-lock.json Dynamically grab readme docs from src css 2018-03-24 10:06:57 -06:00
package.json Ensure max height is persisted, improve format script 2018-03-24 11:36:16 -06:00
principles.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
readme.md Tweak documentation on docs app 2018-03-08 11:54:45 -07:00
responsive.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
scales.md Finish port to latest MDX 2018-03-12 17:30:49 -06:00
sites.md Begin markdown-ifying all the docs 2018-03-07 09:16:15 -07:00
table-of-styles.md Add some more styling 2018-03-09 10:57:12 -07:00
testimonials.md Begin markdown-ifying all the docs 2018-03-07 09:16:15 -07:00

Tachyons Docs

The docs use MDX, React, and the next framework.

Directory structure

  • docs/: markdown documentation, ui components, and react pages
  • docs/pages/: react specific pages served by the docs app
  • docs/ui/: components used by the app and imported by some docs content

Installation

git clone https://github.com/tachyons-css/tachyons
cd tachyons/docs
npm i

Usage

npm run dev