@metamask-previews/platform-api-docs 0.2.1-preview-260a6054e → 0.2.1-preview-136f5f1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -44,9 +44,15 @@ Options:
|
|
|
44
44
|
(required with --strategy root-messenger)
|
|
45
45
|
--output <dir> Output directory (default: <project-path>/.platform-api-docs)
|
|
46
46
|
--project-label <label> Short label identifying the project (e.g. "Core", "Extension")
|
|
47
|
+
--site-url <url> Absolute URL the built site will be served from
|
|
48
|
+
(e.g. https://metamask.github.io)
|
|
49
|
+
--site-base-url <path> Path prefix the built site will be served under
|
|
50
|
+
(e.g. /core/platform-api/)
|
|
47
51
|
--help Show this help message
|
|
48
52
|
```
|
|
49
53
|
|
|
54
|
+
`--site-url` and `--site-base-url` matter when the site is published somewhere other than the root of a domain, such as a GitHub Pages project site. Leave them unset and the site is built for `https://metamask.github.io/`, which makes its asset paths wrong under any other prefix.
|
|
55
|
+
|
|
50
56
|
## Strategies
|
|
51
57
|
|
|
52
58
|
Which strategy to use depends on whether the project has a single messenger carrying every action and event.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask-previews/platform-api-docs",
|
|
3
|
-
"version": "0.2.1-preview-
|
|
3
|
+
"version": "0.2.1-preview-136f5f1",
|
|
4
4
|
"description": "Produces documentation for the platform API, the set of actions and events available in the clients through the message bus",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Ethereum",
|