https://github.com/peakwinter/stork
Static site generator based on Parcel, Pug, Typescript and SASS
https://github.com/peakwinter/stork
Last synced: 7 months ago
JSON representation
Static site generator based on Parcel, Pug, Typescript and SASS
- Host: GitHub
- URL: https://github.com/peakwinter/stork
- Owner: peakwinter
- License: mit
- Created: 2019-03-26T19:13:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:15:11.000Z (over 3 years ago)
- Last Synced: 2025-01-30T14:40:22.856Z (over 1 year ago)
- Language: TypeScript
- Size: 1.99 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stork
Static site generator based on Parcel, Pug, Typescript and SASS
## CLI
* [Stork](#stork)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g stork-ssg
$ stork COMMAND
running command...
$ stork (-v|--version|version)
stork-ssg/1.1.0 darwin-x64 node-v10.15.3
$ stork --help [COMMAND]
USAGE
$ stork COMMAND
...
```
# Commands
* [`stork build`](#stork-build)
* [`stork help [COMMAND]`](#stork-help-command)
* [`stork serve`](#stork-serve)
## `stork build`
builds static site source files into a HTML/asset bundle
```
USAGE
$ stork build
OPTIONS
-h, --help show CLI help
-p, --path=path path to site source
EXAMPLE
$ stork build
✨ Built in 358ms.
```
_See code: [dist/commands/build.ts](https://github.com/peakwinter/stork/blob/v1.1.0/dist/commands/build.ts)_
## `stork help [COMMAND]`
display help for stork
```
USAGE
$ stork help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
## `stork serve`
serves static site source files and rebuilds on changes
```
USAGE
$ stork serve
OPTIONS
-h, --help show CLI help
-p, --path=path path to site source
EXAMPLE
$ stork serve
✨ Built in 358ms.
```
_See code: [dist/commands/serve.ts](https://github.com/peakwinter/stork/blob/v1.1.0/dist/commands/serve.ts)_