Skip to content

Commit 29dab33

Browse files
committed
rebuild docs
1 parent a50bd11 commit 29dab33

File tree

2 files changed

+31
-23
lines changed

2 files changed

+31
-23
lines changed

Diff for: .verb.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
{%= include("header") %}
2+
3+
{%= include("highlight") %}
4+
5+
## TOC
6+
<!-- toc -->
7+
18
## Usage
29

310
The module exposes a function that must be called to get the regex (modified from the split device regex in the node.js path module);
@@ -9,4 +16,26 @@ console.log(pathRootRegex() instanceof RegExp);
916
//=> true
1017
```
1118

12-
See the [path-root][] module for examples.
19+
See the [path-root][] module for examples.
20+
21+
## Related projects
22+
{%= include("related-list") %}
23+
24+
## Contributing
25+
{%= include("contributing") %}
26+
27+
## Running tests
28+
{%= include("tests") %}
29+
30+
## Author
31+
{%= include("author") %}
32+
33+
## License
34+
{%= copyright({linkify: true}) %}
35+
{%= license %}
36+
37+
***
38+
39+
{%= include("footer") %}
40+
41+
{%= reflinks(verb.reflinks) %}

Diff for: README.md

+1-22
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22

33
> Regular expression for getting the root of a posix or windows filepath.
44
5-
## Install
6-
7-
Install with [npm](https://www.npmjs.com/):
8-
9-
```sh
10-
$ npm install path-root-regex --save
11-
```
5+
You might also be interested in [path-root](https://github.com/jonschlinkert/path-root).
126

137
## Usage
148

@@ -29,26 +23,11 @@ You might also be interested in these projects:
2923

3024
* [is-absolute](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
3125
* [parse-filepath](https://www.npmjs.com/package/parse-filepath): Parse a filepath into an object. Falls back on the native node.js `path.parse` method if… [more](https://www.npmjs.com/package/parse-filepath) | [homepage](https://github.com/jonschlinkert/parse-filepath)
32-
* [path-root](https://www.npmjs.com/package/path-root): Get the root of a posix or windows filepath. | [homepage](https://github.com/jonschlinkert/path-root)
3326

3427
## Contributing
3528

3629
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root-regex/issues/new).
3730

38-
## Building docs
39-
40-
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
41-
42-
```sh
43-
$ npm install verb && npm run docs
44-
```
45-
46-
Or, if [verb](https://github.com/verbose/verb) is installed globally:
47-
48-
```sh
49-
$ verb
50-
```
51-
5231
## Running tests
5332

5433
Install dev dependencies:

0 commit comments

Comments
 (0)