Skip to content

Commit

Permalink
Remove instructions for building docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamwathan committed Sep 22, 2018
1 parent 750b62c commit 17ed07a
Showing 1 changed file with 0 additions and 52 deletions.
52 changes: 0 additions & 52 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,55 +31,3 @@ npm test
```

Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Tailwind, please include tests.

## Building the documentation

Tailwind uses the [Jigsaw](http://jigsaw.tighten.co/) static site generator for its documentation. Here is how you can generate the documentation locally:

1. Go to your Tailwind folder

```sh
cd tailwindcss
```

2. Install JS dependencies

```sh
npm install
```

3. Transpile the source code

```sh
npm run prepare
```

4. Go to docs folder

```sh
cd docs
```

5. Install PHP dependencies for docs (requires Composer: https://getcomposer.org)

```sh
composer install
```

6. Install JS dependencies for docs

```sh
npm install
```

7. Run the build to generate the static site

```sh
npm run dev
```

8. View the static site at `/tailwind/docs/build_local`, or you can run the Jigsaw server:

```sh
./vendor/bin/jigsaw serve
```

0 comments on commit 17ed07a

Please sign in to comment.