You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+7-40
Original file line number
Diff line number
Diff line change
@@ -353,44 +353,6 @@ $ stdlib repl
353
353
354
354
### Environment Builds
355
355
356
-
<aname="install_env_builds_jquery"></a>
357
-
358
-
#### jQuery-like Bundle
359
-
360
-
For those wanting a jQuery-like bundle, one can use pre-built distributable UMD bundles for use in browser environments or as shared ("vendored") libraries in server environments, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles].
361
-
362
-
As an example, to include a UMD bundle exposing lower-level special [math functions][@stdlib/math/base/special] in a webpage, we can first locally install the UMD bundle package using [npm][npm]
363
-
364
-
<!-- run-disable -->
365
-
366
-
```bash
367
-
$ npm install @stdlib/dist-math-base-special-flat
368
-
```
369
-
370
-
and then include the following `<script>` tag in our HTML document
making sure to modify the script path based on the local installation directory.
379
-
380
-
If no recognized module system is present, one can access bundle contents in another `<script>` tag via the global scope.
381
-
382
-
<!-- run-disable -->
383
-
384
-
```html
385
-
<scripttype="text/javascript">
386
-
// If no recognized module system present, exposed to global scope:
387
-
var erf =stdlib_math_base_special_flat.erf;
388
-
console.log( erf( 0.5 ) );
389
-
</script>
390
-
```
391
-
392
-
For more details and available bundles, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles]. The [guide][stdlib-bundles] includes instructions for consuming via CDNs, such as [unpkg][unpkg].
For those wanting a jQuery-like bundle, one can use pre-built distributable UMD bundles for use in browser environments or as shared ("vendored") libraries in server environments available in each package's repository via a dedicated `umd` branch. See sections [UMD](#install_env_builds_umd) and [Node.js](#install_env_builds_nodejs) for more details.
398
+
430
399
<a name="install_env_builds_umd"></a>
431
400
432
401
#### UMD
@@ -812,8 +781,6 @@ Test and build infrastructure is generously provided by the following services:
Copy file name to clipboardexpand all lines: dist/README.md
+1-71
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ limitations under the License.
26
26
27
27
<sectionclass="intro">
28
28
29
-
This directory contains packages exporting distributable files for use in browser environments or as shared ("vendored") libraries in server environments. Each distributable file is a standalone [UMD][umd] bundle which, if no recognized module system is present, will expose bundle contents to the global scope.
29
+
This directory is reserved for packages exporting distributable files for use in browser environments or as shared ("vendored") libraries in server environments.
30
30
31
31
</section>
32
32
@@ -36,44 +36,6 @@ This directory contains packages exporting distributable files for use in browse
36
36
37
37
<sectionclass="usage">
38
38
39
-
## Usage
40
-
41
-
First, install one of the packages in this directory containing distributable files. For example, to install the main [stdlib][stdlib] bundle
If no recognized module system is present, access bundle contents via the global scope. For example, assuming the flat namespace bundle sourced above,
68
-
69
-
```html
70
-
<scripttype="text/javascript">
71
-
// `stdlib` is a global variable...
72
-
var erf =stdlib.base.erf;
73
-
console.log( erf( 0.5 ) );
74
-
</script>
75
-
```
76
-
77
39
</section>
78
40
79
41
<!-- /.usage -->
@@ -82,22 +44,6 @@ If no recognized module system is present, access bundle contents via the global
82
44
83
45
<sectionclass="notes">
84
46
85
-
## Notes
86
-
87
-
- Bundles are one of two namespace types: `flat` or `tree`. A `tree` namespace is a nested object namespace which mirrors the project's layout (e.g., `stdlib.math.base.special.erf`). A `flat` namespace uses the global alias [namespace][@stdlib/namespace], where each package has a unique alias (e.g., `stdlib.base.erf`). Which namespace is preferred depends on personal taste and application context.
88
-
89
-
- Each minified bundle has a corresponding [gzip][gzip]-compressed bundle. The [gzip][gzip] compression level for each compressed bundle is `9`, which is the highest (and most optimal) compression level. Deciding between uncompressed and compressed bundles depends on the application and whether compression is handled elsewhere in the application stack (e.g., [nginx][nginx], [CDN][cdn], _et cetera_).
90
-
91
-
- While you are **strongly** encouraged to **vendor** bundles and host with a [CDN][cdn]/provider which can provide availability **guarantees**, especially for production applications, bundles are available via [unpkg][unpkg] for quick demos, proof-of-concepts, and instructional material. For example,
Please be mindful that [unpkg][unpkg] is a free, best-effort service relying on donated infrastructure which does **not** provide **any** availability guarantees. Under **no** circumstances should you **abuse** or **misuse** the service. You have been **warned**.
98
-
99
-
- If you intend on embedding a standalone bundle **within** another bundle, you may need to rename `require` calls within the standalone bundle **before** bundling in order to maintain scoped module resolution. For example, if you plan on using [browserify][browserify] to generate a bundle containing embedded bundles, [browserify][browserify] plugins exist to "de-require" those bundles prior to bundling.
100
-
101
47
</section>
102
48
103
49
<!-- /.notes -->
@@ -106,22 +52,6 @@ If no recognized module system is present, access bundle contents via the global
0 commit comments