Skip to content
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

Fix Snowpack docs for homepage config #511

Merged
merged 1 commit into from
Jun 18, 2020
Merged

Fix Snowpack docs for homepage config #511

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 1 addition & 6 deletions docs/docs/05-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ $ snowpack dev --no-bundle
"unistore/full/preact.es.js", // An ESM file within a package (supports globs)
"bulma/css/bulma.css" // A non-JS static asset (supports globs)
],
"homepage": "/your-project",
"scripts": { /* ... */ },
"installOptions": { /* ... */ },
"devOptions": { /* ... */ },
Expand All @@ -64,10 +63,6 @@ $ snowpack dev --no-bundle
- Useful for excluding tests and other unnecessary files from the final build. Supports glob pattern matching.
- **`install`** | `string[]`
- Known dependencies to install with Snowpack. Useful for installing packages manually and any dependencies that couldn't be detected by our automatic import scanner (ex: package CSS files).
- **`homepage`** | `string`
- By default, Snowpack's builds your app assuming it will be hosted at the server root.
- You can set the "homepage" whenever your project is deployed anywhere other than the domain's root URL.
- Note: Snowpack will also read this value from your `package.json` manifest.
- **`scripts`**
- Set build scripts to transform your source files. See the section below for more info.
- **`installOptions.*`**
Expand Down Expand Up @@ -126,7 +121,7 @@ $ snowpack dev --no-bundle
#### Build Options

- **`baseUrl`** | `string` | Default: `/`
- In your HTML, replace all instances of `%PUBLIC_URL%` with this (inspired by the same [Create React App](https://create-react-app.dev/docs/using-the-public-folder/) concept). This is useful if your app will be deployed to a subdirectory.
- In your HTML, replace all instances of `%PUBLIC_URL%` with this (inspired by the same [Create React App](https://create-react-app.dev/docs/using-the-public-folder/) concept). This is useful if your app will be deployed to a subdirectory. _Note: if you have `homepage` in your `package.json`, Snowpack will actually pick up on that, too._
- **`metaDir`** | `string` | Default: `__snowpack__`
- By default, Snowpack outputs Snowpack-related metadata such as [HMR](#hot-module-replacement) and [ENV](#environment-variables) info to a folder called `__snowpack__`. You can rename that folder with this option (e.g.: `metaDir: 'static/snowpack'`).

Expand Down