Skip to content

Added docs for --template #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rkostrzewski merged 2 commits into from
Jul 5, 2017
Merged

Added docs for --template #193

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2f5474
Added docs for --template
framp Jul 5, 2017
82951d4
refactor: Remove empty defaults & fix indent in indent
rkostrzewski Jul 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,42 +50,44 @@ npm run build
```sh
$ preact create

--name directory and package name for the new app
--dest Directory to create the app within [default: <name>]
--type A project template to start from
--name directory and package name for the new app.
--dest Directory to create the app within. [default: <name>]
--type A project template to start from.
[Options: "default", "root", "simple", "empty"] [default: "default"]
--less Pre-install LESS support [boolean] [default: false]
--sass Pre-install SASS/SCSS support [boolean] [default: false]
--git Initialize version control using git [boolean] [default: true]
--less Pre-install LESS support. [boolean] [default: false]
--sass Pre-install SASS/SCSS support. [boolean] [default: false]
--git Initialize version control using git. [boolean] [default: true]

$ preact build

--src Entry file (index.js) [default: "src"]
--dest Directory root for output [default: "build"]
--src Entry file (index.js). [default: "src"]
--dest Directory root for output. [default: "build"]
--production, -p Create a minified production build. [default: true]
--less, -l Build and compile LESS files [default: false]
--sass, -s Build and compile SASS files [default: false]
--less, -l Build and compile LESS files. [default: false]
--sass, -s Build and compile SASS files. [default: false]
--prerender Pre-render static app content. [default: true]
--template Path to template file.
--clean Clear output directory before building. [default: true]
--json Generate build statistics for analysis. [default: false]
--config, -c Path to custom CLI config.

$ preact watch

--src Entry file (index.js) [default: "src"]
--port, -p Port to start a server on [default: "8080"]
--src Entry file (index.js). [default: "src"]
--port, -p Port to start a server on. [default: "8080"]
--host [boolean] [default: "0.0.0.0"]
--prerender Pre-render static app content on initial build [default: false]
--prerender Pre-render static app content on initial build. [default: false]
--template Path to template file.

$ preact serve

--dir Directory root to serve static files from. [default: "build"]
--cwd The working directory in which to spawn a server. [default: .]
--server Which server to run, or "config" to produce a firebase config.
[options: "simplehttp2server", "superstatic", "config"] [default:"simplehttp2server"]
--dest Directory or filename where firebase.json should be written
--dest Directory or filename where firebase.json should be written.
(used for --server config) [default: -]
--port, -p Port to start a server on [default: "8080"]
--port, -p Port to start a server on. [default: "8080"]

```

Expand Down Expand Up @@ -142,6 +144,18 @@ export default function (config, env, helpers) {
```
See [WebpackConfigHelpers] docs for more info on ```helpers``` argument.

#### Template
A template is used to render your page.

The default one is visible [here](src/resources/template.html) and it's going to be enough for the majority of cases.

If you want to customise your template you can pass a custom template with the `--template` flag.

The `--template` flag is available on the `build` and `watch` commands.
```
preact build --template src/template.html
preact watch --template src/template.html
```

[preact]: https://github.com/developit/preact
[preact-router]: https://github.com/developit/preact-router
Expand Down