Skip to content

Commit 0ca0e3b

Browse files
stringparserstringparser
committed
docs: add crosslinks and navigation
1 parent 7d4543e commit 0ca0e3b

File tree

6 files changed

+67
-7
lines changed

6 files changed

+67
-7
lines changed

‎docs/API.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
7+
18
## API
29

310
The module has 2 static methods
@@ -202,6 +209,9 @@ Each `tasks...` can be either a `string` or a `function`.
202209

203210
If given, `options` will override the instance `props` for this `stack`.
204211

212+
---
213+
[Back to top ↑](#)
214+
205215
<!-- links -->
206216

207217
[npm]: https://npmjs.com/gulp-runtime

‎docs/CLI.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
17

28
## CLI
39

@@ -14,3 +20,6 @@ gulp.task('info', ['--tasks', '--version']);
1420
// other tasks...
1521
gulp.task('default', ['info']);
1622
```
23+
24+
---
25+
[Back to top ↑](#)

‎docs/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
7+
18
> Found something wrong or missing? [Open an issue!](open-an-issue)
29
310
<h1>documentation</h1>
@@ -48,6 +55,8 @@
4855

4956
`gulp-runtime --tasks default watch serve`
5057

58+
---
59+
[Back to top ↑](#)
5160

5261
<!-- links -->
5362

‎docs/REPL.md‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
17

2-
## REPL
8+
9+
# REPL
310

411
```js
5-
var gulp = require('gulp-runtime').create({repl: true});
12+
var gulp = require('gulp-runtime').create({ repl: true });
613
```
714

815
When an instance passes `repl: true` the process running does not exit when all tasks are done. For this case, REPL listening on `stdin`.
@@ -20,4 +27,9 @@ press enter and you will see a prompt `>` that will run the tasks defined in the
2027

2128
For more information about how tasks are run see [gulp-repl][gulp-repl].
2229

30+
---
31+
[Back to top ↑](#)
32+
33+
<!-- links -->
34+
2335
[gulp-repl]: https://github.com/stringparser/gulp-repl

‎docs/logging.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
## log
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
7+
8+
# Logging
29

310
Callbacks passed to the constructor: `onHandleStart`, `onHandleEnd` and `onHandleError` are used to internally to produce logging but they can be overridden at:
411

5-
- class level with [`Gulp.createClass`](#gulpcreateclass)
12+
- class level with [`Gulp.createClass`](./API.md#gulpcreateclass)
613
- instance level with `Gulp.create`
7-
- bunlde/run level using one of the composers ([`gulp.start`](#gulpstart), [`gulp.series`](#gulpseries), [`gulp.parallel`](#gulpparallel) and [`gulp.stack`](#gulpstack)).
14+
- bunlde/run level using one of the composers ([`gulp.start`](./API.md#gulpstart), [`gulp.series`](./API.md#gulpseries), [`gulp.parallel`](./API.md#gulpparallel) and [`gulp.stack`](./API.md#gulpstack)).
815

916
Example:
1017

@@ -43,3 +50,6 @@ myGulp.stack('one', 'two', 'three', {
4350
}
4451
})();
4552
```
53+
54+
---
55+
[Back to top ↑](#)

‎docs/task-arguments.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
## Task arguments
1+
[docs](./README.md) |
2+
[API](./API.md) |
3+
[CLI](./CLI.md) |
4+
[Logging](./logging.md) |
5+
[REPL](./REPL.md) |
6+
[task arguments](./task-arguments.md)
27

3-
Any of the task runners ([`gulp.start`](#gulpstart), [`gulp.series`](#gulpseries), [`gulp.parallel`](#gulpparallel) and [`gulp.stack`](#gulpstack)) can be used to pass arguments down.
8+
# Task arguments
9+
10+
Any of the task runners ([`gulp.start`](./API.md#gulpstart), [`gulp.series`](./API.md#gulpseries), [`gulp.parallel`](./API.md#gulpparallel) and [`gulp.stack`](./API.md#gulpstack)) can be used to pass arguments down.
411

512
```js
613
var gulp = require('gulp-runtime').create();
@@ -36,3 +43,6 @@ gulp.task('default', function (done) {
3643
})
3744
});
3845
```
46+
47+
---
48+
[Back to top ↑](#)

0 commit comments

Comments
 (0)