Skip to content

Commit

Permalink
Disable running examples
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed May 31, 2022
1 parent 8ed11d5 commit 91dd110
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,12 +336,16 @@ For those wanting a jQuery-like bundle, one can use pre-built distributable UMD

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]

<!-- run-disable -->

```bash
$ npm install @stdlib/dist-math-base-special-flat
```

and then include the following `<script>` tag in our HTML document

<!-- run-disable -->

```html
<script type="text/javascript" src="/path/to/@stdlib/dist-math-base-special-flat/build/bundle.min.js"></script>
```
Expand All @@ -350,6 +354,8 @@ making sure to modify the script path based on the local installation directory.

If no recognized module system is present, one can access bundle contents in another `<script>` tag via the global scope.

<!-- run-disable -->

```html
<script type="text/javascript">
// If no recognized module system present, exposed to global scope:
Expand All @@ -366,6 +372,8 @@ For more details and available bundles, see the [`dist`][stdlib-bundles] directo

To use ES Modules via a `<script>` tag, use **ES Module builds** available in each package's repository via a dedicated `esm` branch (e.g., see the [`esm`][@stdlib/math-base-special-erf-esm] branch for [`@stdlib/math-base-special-erf`][@stdlib/math-base-special-erf-esm]). For example,

<!-- run-disable -->

```html
<script type="module">
Expand Down Expand Up @@ -402,6 +410,8 @@ var arr = ndarray( [ [ 1, 2 ], [ 3, 4 ] ] );

To use UMD bundles either via a `<script>` tag or in [Observable][observable], use UMD **browser builds** available in each package's repository via a dedicated `umd` branch (e.g., see the [`umd`][@stdlib/math-base-special-erf-umd] branch for [`@stdlib/math-base-special-erf`][@stdlib/math-base-special-erf-umd]). For example,
<!-- run-disable -->
```html
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-erf@umd/browser.js"></script>
Expand All @@ -425,6 +435,8 @@ for ( i = 0; i < x.length; i++ ) {
To **vendor** stdlib functionality and avoid installing dependency trees, use UMD **server builds** available in each package's repository via a dedicated `umd` branch (e.g., see the [`umd`][@stdlib/math-base-special-erf-umd] branch for [`@stdlib/math-base-special-erf`][@stdlib/math-base-special-erf-umd]). For example,

<!-- run-disable -->

```javascript
var linspace = require( '/path/to/vendor/umd/@stdlib/array-base-linspace' );
var erf = require( '/path/to/vendor/umd/@stdlib/math-base-special-erf' );
Expand Down

0 comments on commit 91dd110

Please sign in to comment.