Skip to content

Commit

Permalink
Update development workflow (closes #96)
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Apr 5, 2020
1 parent 177f978 commit 36b5cf8
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,36 @@ This is the repository containing the code for the official gulp website [gulpjs
![A screenshot of gulpjs.com](screenshot.png)

## Contributing
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

### Getting started

To get started working on this site you first need to clone this repository

```
$ git clone https://github.com/gulpjs/gulpjs.github.io.git
$ git clone git://github.com/gulpjs/gulpjs.github.io
```

__The rest is a work in progress, we'll update once things are working__

When you are done making your improvements, create a [Pull Request](https://github.com/gulpjs/gulpjs.github.io/compare).

### Installation

```
$ npm install
```

### Local Development

```
$ npm start
```

This command will first pull down the markdown documentation from the main gulp repository, then starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

0 comments on commit 36b5cf8

Please sign in to comment.