Remove instructions for building docs
This commit is contained in:
parent
750b62c5d2
commit
17ed07a28e
1 changed files with 0 additions and 52 deletions
52
.github/CONTRIBUTING.md
vendored
52
.github/CONTRIBUTING.md
vendored
|
|
@ -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
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue