Skip to content
This repository was archived by the owner on Jan 2, 2018. It is now read-only.

Commit a1f1a79

Browse files
dlmrdlmr
committed
Regenerated documentation
1 parent 0af2b6d commit a1f1a79

16 files changed

Lines changed: 87 additions & 66 deletions

File tree

‎extensions/roc-plugin-react-dev/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Adds React support to Webpack and Roc (Development)
44

55
## Documentation
6-
- [Actions](/docs/Actions)
7-
- [Commands](/docs/Commands)
8-
- [Configuration](/docs/Configuration)
9-
- [Dependencies](/docs/Dependencies)
10-
- [Hooks](/docs/Hooks)
11-
- [Settings](/docs/Settings)
12-
- [Extensions](/docs/Extensions)
6+
- [Actions](docs/Actions.md)
7+
- [Commands](docs/Commands.md)
8+
- [Configuration](docs/Configuration.md)
9+
- [Dependencies](docs/Dependencies.md)
10+
- [Hooks](docs/Hooks.md)
11+
- [Settings](docs/Settings.md)
12+
- [Extensions](docs/Extensions.md)
1313

1414
---
15-
_Generated by [Roc](https://github.com/rocjs/roc)_
15+
_Generated by [Roc](https://github.com/rocjs/roc)_

‎extensions/roc-plugin-react-dev/docs/Actions.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ Adds the needed Webpack configuration to be able to build and develop React code
1212

1313
__Connects to extension:__ Not specified
1414
__Connects to hook:__ `build-webpack`
15+
__Have post:__ No

‎extensions/roc-plugin-react-dev/docs/Commands.md‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# Commands for `roc-plugin-react-dev`
22

33
## General Information
4-
All commands can be called with some additional options as can be seen below.
4+
All commands can be called with some additional options illustrated in the table below.
55

66
### General options
7-
| Name | Description | Required |
8-
| --------------- | ------------------------------------------------------------------------------------------------------------- | -------- |
9-
| -c, --config | Path to configuration file, will default to roc.config.js in current working directory. | No |
10-
| -d, --directory | Path to working directory, will default to the current working directory. Can be either absolute or relative. | No |
11-
| -h, --help | Output usage information. | No |
12-
| -V, --verbose | Enable verbose mode. | No |
13-
| -v, --version | Output version number. | No |
7+
8+
| Name | Description | Required |
9+
| --------------------- | ---------------------------------------------- | -------- |
10+
| -b, --better-feedback | Enables source-map-support and loud-rejection. | No |
11+
| -c, --config | Path to configuration file. | No |
12+
| -d, --directory | Path to working directory. | No |
13+
| -h, --help | Output usage information. | No |
14+
| -V, --verbose | Enable verbose mode. | No |
15+
| -v, --version | Output version number. | No |
1416

1517
## Commands
1618
* [meta](#meta)
@@ -34,13 +36,14 @@ roc meta docs
3436
```
3537

3638
#### Command options
37-
| Name | Description | Default | Type | Required | Can be empty |
38-
| --------------- | ----------- | -------------- | ---- | -------- | ------------ |
39-
| --hide-commands | | | | No | Yes |
40-
| --html | | `false` | | No | Yes |
41-
| --markdown | | `true` | | No | Yes |
42-
| --mode | | `"github.com"` | | No | Yes |
43-
| --output | | `"docs"` | | No | Yes |
39+
40+
| Name | Description | Default | Type | Required | Can be empty |
41+
| ---------- | ------------------------------------------------------------- | -------------- | ----------------------------------------------------------------- | -------- | ------------ |
42+
| --html | If HTML should be generated. (Not supported yet) | `false` | `Boolean` | No | |
43+
| --markdown | If markdown should be generated. | `true` | `Boolean` | No | |
44+
| --mode | The platform that is to be used, for link generation. | `"github.com"` | `/github\.com|nodejs\.org|bitbucket\.org|ghost\.org|gitlab\.com/` | No | |
45+
| --output | A directory to place the generated documentation inside of. | `"docs"` | `String` | No | No |
46+
| --project | If the projects configuration and actions should be included. | `false` | `Boolean` | No | |
4447

4548
#### Defined by extensions
4649
roc

‎extensions/roc-plugin-react-dev/docs/Configuration.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Config for `roc-plugin-react-dev`
22

3-
Configuration that can be defined in `roc.config.js`, other than settings, init and actions.
3+
Configuration that can be defined in `roc.config.js`, other than settings and project.
44

5-
__No config available.__
5+
__No config available.__

‎extensions/roc-plugin-react-dev/docs/Dependencies.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ The dependencies that are available in the project.
77
__Version__: ~15.0.1
88
__Extension__: roc-plugin-react
99
__Custom resolve function__: No
10+
1011
### [react-dom](https://www.npmjs.com/package/react-dom)
1112
__Version__: ~15.0.1
1213
__Extension__: roc-plugin-react
1314
__Custom resolve function__: No
1415

16+
## Requires
17+
Nothing is required.
18+
1519
## Uses
1620
Nothing is listed as used.
17-
18-
## Requires
19-
Nothing is required.

‎extensions/roc-plugin-react-dev/docs/Extensions.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Extensions for `roc-plugin-react-dev`
22

3-
The extensions that are used in the project, indirect and direct.
3+
The extensions that are used in the project, indirect and direct, in the order that they were added.
4+
45
## Packages
5-
No packages.
6+
_No packages._
7+
68
## Plugins
79
### roc-plugin-react — [v1.0.0-beta.0](https://www.npmjs.com/package/roc-plugin-react)
8-
Adds React support to Webpack and Roc
10+
Adds React support to Webpack and Roc

‎extensions/roc-plugin-react-dev/docs/Hooks.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@
1010

1111
Expected to return new settings that should be merged with the existing ones.
1212

13+
Makes it possible to modify the settings object before a command is started and after potential arguments from the command line and configuration file have been parsed. This is a good point to default to some value if no was given or modify something in the settings.
14+
1315
__Initial value:__ _Nothing_
1416
__Expected return value:__ `{}`
1517

1618
#### Arguments
19+
1720
| Name | Description | Type | Required | Can be empty |
1821
| ----------- | ---------------------------------------------------------------------------- | ---------- | -------- | ------------ |
19-
| getSettings | A function that returns the settings after the context has been initialized. | `Function` | No | Yes |
22+
| getSettings | A function that returns the settings after the context has been initialized. | `Function` | No | |

‎extensions/roc-plugin-react-dev/docs/Settings.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## Dev
44

5+
56
### HotMiddleware
7+
68
| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions |
79
| ------ | ----------- | ------------------------ | -------------------------- | ------- | --------- | -------- | ------------ | -------------------- |
810
| reload | | dev.hotMiddleware.reload | --dev-hotMiddleware-reload | `false` | `Unknown` | No | Yes | roc-plugin-react-dev |

‎extensions/roc-plugin-react/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Adds React support to Webpack and Roc
44

55
## Documentation
6-
- [Actions](/docs/Actions)
7-
- [Commands](/docs/Commands)
8-
- [Configuration](/docs/Configuration)
9-
- [Dependencies](/docs/Dependencies)
10-
- [Hooks](/docs/Hooks)
11-
- [Settings](/docs/Settings)
12-
- [Extensions](/docs/Extensions)
6+
- [Actions](docs/Actions.md)
7+
- [Commands](docs/Commands.md)
8+
- [Configuration](docs/Configuration.md)
9+
- [Dependencies](docs/Dependencies.md)
10+
- [Hooks](docs/Hooks.md)
11+
- [Settings](docs/Settings.md)
12+
- [Extensions](docs/Extensions.md)
1313

1414
---
15-
_Generated by [Roc](https://github.com/rocjs/roc)_
15+
_Generated by [Roc](https://github.com/rocjs/roc)_

‎extensions/roc-plugin-react/docs/Actions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Actions for `roc-plugin-react`
22

3-
__No actions available.__
3+
__No actions available.__

0 commit comments

Comments
 (0)