Skip to content

Commit 36b5cf8

Browse files
committed
Update development workflow (closes #96)
1 parent 177f978 commit 36b5cf8

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,36 @@ This is the repository containing the code for the official gulp website [gulpjs
55
![A screenshot of gulpjs.com](screenshot.png)
66

77
## Contributing
8+
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
9+
10+
### Getting started
811

912
To get started working on this site you first need to clone this repository
13+
1014
```
11-
$ git clone https://github.com/gulpjs/gulpjs.github.io.git
15+
$ git clone git://github.com/gulpjs/gulpjs.github.io
1216
```
1317

14-
__The rest is a work in progress, we'll update once things are working__
15-
1618
When you are done making your improvements, create a [Pull Request](https://github.com/gulpjs/gulpjs.github.io/compare).
19+
20+
### Installation
21+
22+
```
23+
$ npm install
24+
```
25+
26+
### Local Development
27+
28+
```
29+
$ npm start
30+
```
31+
32+
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.
33+
34+
### Build
35+
36+
```
37+
$ npm build
38+
```
39+
40+
This command generates static content into the `build` directory and can be served using any static contents hosting service.

0 commit comments

Comments
 (0)