Skip to content

Commit 396ca5c

Browse files
serve docs
1 parent b879792 commit 396ca5c

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,15 @@ Then in your _package.json_, you can run the CLI like so:
3131
"scripts": {
3232
"build": "greenwood build",
3333
"start": "greenwood develop",
34-
"eject": "greenwood eject",
34+
"serve": "greenwood serve",
35+
"eject": "greenwood eject"
3536
}
3637
```
3738

38-
- `npm run build`: generates a static build of your project
39-
- `npm start`: starts a local development server for your project
40-
- `npm run eject`: ejects configurations to your working directory for additional customizations
39+
- `greenwood build`: Generates a production build of your project
40+
- `greenwood develop`: Starts a local development server for your project
41+
- `greenwood serve`: Generates a production build of the project and serves it locally on a simple web server.
42+
- `greenwood eject`: Ejects configurations to your working directory for additional customizations.
4143

4244
## Documentation
4345
All of our documentation is on our [website](https://www.greenwoodjs.io/) (which itself is built by Greenwood!). See our website documentation to learn more about:

www/pages/docs/index.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,21 @@ With Greenwood installed, you can run its CLI to generate your site. The comman
3030
- `develop`: Develop your project with a local development server.
3131
- `build`: For generating a production ready static site.
3232

33-
As mentioned above, it is recommended to install Greenwood locally into your project. From there, you can define npm scripts in _package.json_:
33+
As mentioned above, it is recommended to install Greenwood locally into your project. From there, you can define npm scripts in _package.json_ like so:
3434

3535
```json
3636
"scripts": {
3737
"build": "greenwood build",
38-
"start": "greenwood develop"
39-
},
38+
"start": "greenwood develop",
39+
"serve": "greenwood serve"
40+
}
4041
```
4142

4243
Then you can run:
43-
- `npm run build` - generate a static build of your project for production
44-
- `npm start` - starts a development server for local development
44+
- `greenwood build`: Generates a production build of your project
45+
- `greenwood develop`: Starts a local development server for your project
46+
- `greenwood serve`: Generates a production build of the project and serves it locally on a simple web server.
47+
- `greenwood eject`: Ejects configurations to your working directory for additional customizations.
4548

4649
### Sections
4750
- [Component Model](/docs/component-model/): Examples of using custom elements in Greenwood.

0 commit comments

Comments
 (0)