Skip to content

Commit

Permalink
docs(compiler): remove docs on loading the Stencil compiler in a Web …
Browse files Browse the repository at this point in the history
…Worker or browser (#1391)

* docs(compiler): don't recommend embedding compiler as browser script

* docs(compiler): don't recommend embedding compiler within service worker either

* revert esm import doc
  • Loading branch information
christian-bromann authored Apr 3, 2024
1 parent 7313d04 commit 999d831
Show file tree
Hide file tree
Showing 16 changed files with 0 additions and 144 deletions.
9 changes: 0 additions & 9 deletions docs/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.0/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.1/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.10/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.11/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.12/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.13.0/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.14/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.2/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.3/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.4/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.5/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.6/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.7/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.8/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down
9 changes: 0 additions & 9 deletions versioned_docs/version-v4.9/core/compiler-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The
```tsx
// NodeJS (commonjs)
const stencil = require('@stencil/core/compiler');

// Web Worker from CDN URL (add the version to in the URL)
importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js');
// self.stencil will be available after the script import

// Browser Window
<script src="https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js"></script>
// window.stencil will be available after the script executes
```


## transpile()

```tsx
Expand Down

0 comments on commit 999d831

Please sign in to comment.