tachyons/docs
2018-11-10 09:41:39 -07:00
..
addons Add tachyons-opacity-responsive docs 2018-11-10 09:38:51 -07:00
build Move static generated json files to data dir 2018-11-10 09:41:02 -07:00
components Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
data Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
elements Spike in most of content wrapper changes 2018-11-10 09:38:51 -07:00
grid Spike in most of content wrapper changes 2018-11-10 09:38:51 -07:00
layout Add more references to widths docs 2018-11-10 09:38:51 -07:00
pages Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
themes Updates to display and border radius docs 2018-11-10 09:38:51 -07:00
typography Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
ui Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
.gitignore Ignore component loader in module build 2018-11-10 09:41:01 -07:00
class-naming.md Fix typos 2018-11-10 09:41:01 -07:00
faq.md Add James Greig's WIP FAQ 2018-11-10 09:29:15 -07:00
features.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
generator.md Add elements docs 2018-11-10 09:29:15 -07:00
getting-started.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
installation.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
introduction.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
next.config.js Implement basic source file generation 2018-11-10 09:41:01 -07:00
package-lock.json Bump deps for docs, remove yarn.lock 2018-11-10 09:41:39 -07:00
package.json Bump deps for docs, remove yarn.lock 2018-11-10 09:41:39 -07:00
principles.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
readme.md Tweak documentation on docs app 2018-11-10 09:29:33 -07:00
responsive.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
scales.md Finish port to latest MDX 2018-11-10 09:38:51 -07:00
sites.md Begin markdown-ifying all the docs 2018-11-10 09:28:30 -07:00
table-of-styles.md Begin updating to latest Tachyons version 2018-11-10 09:41:39 -07:00
testimonials.md Begin markdown-ifying all the docs 2018-11-10 09:28:30 -07:00
yarn.lock Generate more components 2018-11-10 09:41:37 -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