From e0a1483bd6e0beeead2fd19cbc826aea9c662d5f Mon Sep 17 00:00:00 2001 From: Conduitry Date: Thu, 9 Mar 2017 08:15:52 -0500 Subject: [PATCH] fix options table formatting --- README.md | 88 ++++++++----------------------------------------------- 1 file changed, 13 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index b79e924616..e0d96054df 100644 --- a/README.md +++ b/README.md @@ -70,81 +70,19 @@ The Svelte compiler exposes the following API: The Svelte compiler optionally takes a second argument, an object of configuration options: - - - - - - - - - - - - - - -
- **Values** - **Description** - **Default** - -
`format` - `'es'`, `'amd'`, `'cjs'`, `'umd'`, `'iife'`, `'eval'` - The format to output in the compiled component.
`'es'` - ES6/ES2015 module, suitable for consumption by a bundler
`'amd'` - AMD module
`'cjs'` - CommonJS module
`'iife'` - IIFE-wrapped function defining a global variable, suitable for use directly in browser
`'eval'` - standalone function, suitable for passing to `eval()` - 		`'es'` - -
`generate` - `'dom'`, `'ssr'` - Whether to generate JavaScript code intended for use on the client (`'dom'`), or for use in server-side rendering (`'ssr'`). - `'dom'` - -
`name` - `string` - The name of the constructor in the compiled component. - `'SvelteComponent'` - -
`filename` - `string` - The filename to use in sourcemaps and compiler error and warning messages. - `'SvelteComponent.html'` - -
`amd`.`id` - `string` - The AMD module ID to use for the `'amd'` and `'umd'` output formats. - `undefined` - -
`shared` - `true`, `false`, `string` - Whether to import various helpers from a shared external library. When you have a project with multiple components, this reduces the overall size of your JavaScript bundle, at the expense of having immediately-usable component. You can pass a string of the module path to use, or `true` will import from `'svelte/shared.js'`. - `false` - -
`dev` - `true`, `false` - Whether to enable run-time checks in the compiled component. These are helpful during development, but slow your component down. - `false` - -
`css` - `true`, `false` - Whether to include code to inject your component's styles into the DOM. - `true` - -
`globals` - `object`, `function` - When outputting to the `'umd'`, `'iife'` or `'eval'` formats, an object or function mapping the names of imported dependencies to the names of global variables. - `{}` - -
`onerror` - `function` - Specify a callback for when Svelte encounters an error while compiling the component. - (exception is thrown) - -
`onwarn` - `function` - Specify a callback for when Svelte encounters a non-fatal warning while compiling the component. - (warning is logged to console) - -
+| | **Values** | **Description** | **Defaults** | +|---|---|---|---| +| `format` | `'es'`, `'amd'`, `'cjs'`, `'umd'`, `'iife'`, `'eval'` | The format to output in the compiled component.
`'es'` - ES6/ES2015 module, suitable for consumption by a bundler
`'amd'` - AMD module
`'cjs'` - CommonJS module
`'iife'` - IIFE-wrapped function defining a global variable, suitable for use directly in browser
`'eval'` - standalone function, suitable for passing to `eval()` | `'es'` | +| `generate` | `'dom'`, `'ssr'` | Whether to generate JavaScript code intended for use on the client (`'dom'`), or for use in server-side rendering (`'ssr'`). | `'dom'` | +| `name` | `string` | The name of the constructor in the compiled component. | `'SvelteComponent'` | +| `filename` | `string` | The filename to use in sourcemaps and compiler error and warning messages. | `'SvelteComponent.html'` | +| `amd`.`id` | `string` | The AMD module ID to use for the `'amd'` and `'umd'` output formats. | `undefined` | +| `shared` | `true`, `false`, `string` | Whether to import various helpers from a shared external library. When you have a project with multiple components, this reduces the overall size of your JavaScript bundle, at the expense of having immediately-usable component. You can pass a string of the module path to use, or `true` will import from `'svelte/shared.js'`. | `false` | +| `dev` | `true`, `false` | Whether to enable run-time checks in the compiled component. These are helpful during development, but slow your component down. | `false` | +| `css` | `true`, `false` | Whether to include code to inject your component's styles into the DOM. | `true` | +| `globals` | `object`, `function` | When outputting to the `'umd'`, `'iife'` or `'eval'` formats, an object or function mapping the names of imported dependencies to the names of global variables. | `{}` | +| `onerror` | `function` | Specify a callback for when Svelte encounters an error while compiling the component. | (exception is thrown) | +| `onwarn` | `function` | Specify a callback for when Svelte encounters a non-fatal warning while compiling the component. | (warning is logged to console) | ## Example/starter repos