<commit_before># Website URLs

> [remark][remark] plugin to resolve package identifiers to website URIs.

<section class="usage">

## Usage

```javascript
var links = require( '@stdlib/_tools/remark/plugins/remark-stdlib-urls-www' );
```

#### links( options )

Attaches a plugin to a [remark][remark] processor to resolve package identifiers to website URIs.

```javascript
var remark = require( 'remark' );

remark().use( links );
```

The function accepts the following `options`:

-   **version**: documentation version. Default: `develop`.

By default, the plugin resolves package identifiers to the `develop` documentation. To specify an alternative version, set the `version` option.

```javascript
var remark = require( 'remark' );

var opts = {
    'version': 'v1.0.1'
};

remark().use( links, opts );
```

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- run-disable -->

<!-- eslint no-undef: "error" -->

```javascript
var join = require( 'path' ).join;
var toVFile = require( 'to-vfile' );
var remark = require( 'remark' );
var readFileSync = require( '@stdlib/fs/read-file' ).sync;
var links = require( '@stdlib/_tools/remark/plugins/remark-stdlib-urls-www' );

var fpath;
var opts;
var file;
var out;

// Load a Markdown file...
fpath = join( __dirname, 'fixtures/simple.txt' );
opts = {
    'encoding': 'utf8'
};
file = readFileSync( fpath, opts );

// Resolve URIs:
out = remark().use( links ).processSync( file );

// Print the results:
console.log( out.contents );
```

</section>

<!-- /.examples -->

<section class="links">

[remark]: https://github.com/wooorm/remark

</section>

<!-- /.links --><commit_msg>Update path and enable code block<commit_after># Website URLs

> [remark][remark] plugin to resolve package identifiers to website URIs.

<section class="usage">

## Usage

```javascript
var links = require( '@stdlib/_tools/remark/plugins/remark-stdlib-urls-www' );
```

#### links( options )

Attaches a plugin to a [remark][remark] processor to resolve package identifiers to website URIs.

```javascript
var remark = require( 'remark' );

remark().use( links );
```

The function accepts the following `options`:

-   **version**: documentation version. Default: `develop`.

By default, the plugin resolves package identifiers to the `develop` documentation. To specify an alternative version, set the `version` option.

```javascript
var remark = require( 'remark' );

var opts = {
    'version': 'v1.0.1'
};

remark().use( links, opts );
```

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var join = require( 'path' ).join;
var toVFile = require( 'to-vfile' );
var remark = require( 'remark' );
var readFileSync = require( '@stdlib/fs/read-file' ).sync;
var links = require( '@stdlib/_tools/remark/plugins/remark-stdlib-urls-www' );

var fpath;
var opts;
var file;
var out;

// Load a Markdown file...
fpath = join( __dirname, 'examples', 'fixtures', 'simple.txt' );
opts = {
    'encoding': 'utf8'
};
file = readFileSync( fpath, opts );

// Resolve URIs:
out = remark().use( links ).processSync( file );

// Print the results:
console.log( out.contents );
```

</section>

<!-- /.examples -->

<section class="links">

[remark]: https://github.com/wooorm/remark

</section>

<!-- /.links -->
{'fraction_non_alphanumeric': 0.18232044198895028, 'fraction_numerical': 0.0023262576330328583, 'mean_word_length': 3.914285714285714, 'pattern_counts': {'":': 0, '<': 30, '<?xml version=': 0, '>': 32, 'https://': 2, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5939285', 'n_tokens_mistral': 1126, 'n_tokens_neox': 1082, 'n_words': 336}