Skip to content
This repository has been archived by the owner on Nov 28, 2023. It is now read-only.

Commit

Permalink
Merge pull request #46 from andi1984/feature/24-node-script
Browse files Browse the repository at this point in the history
New dev command to start a static file server and watch changes.
  • Loading branch information
andi1984 committed Apr 2, 2020
2 parents d4e2eea + ccf09c5 commit baf5151
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ The HTML content of the markdown files is going to be passed as `content` variab

The output files are saved to the `dist` directory.

## NPM scripts

| Name | Description |
| ------------- | ---------------------------------------------------------------------------------------- |
| test | Self-exploratory: Run your test suite here. |
| tsc | Runs the typescript compiler and checks for errors |
| dev | Starts a static file server and watches for content (e.g. template) or typescript files. |
| watch-content | Watches for content (template) changes |
| watch | Watches for changes on the core typescript files for the static page generator itself. |
| build | Builds the output static HTML files. |
| assets | Task for you to generate your assets with. |
| start | Build HTML files using `build` task and builds assets with `assets` task. |
| release | Command to generate a new release version. |

## Twig Template Variables

| Variable | Description | Example |
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"scripts": {
"test": "jest",
"tsc": "tsc",
"dev": "npx concurrently \"npx http-server dist\" \"npm run watch-content\" \"npm run watch\"",
"watch-content": "npm-watch",
"watch": "ts-node-dev --respawn --transpileOnly ./build.ts",
"build": "tsc && node ./build/build.js",
Expand Down

0 comments on commit baf5151

Please sign in to comment.