@pathmx/paths 0.5.6 → 0.6.0
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 +1 -40
- package/index.ts +8 -10
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -5,8 +5,6 @@ and Player at matching PathMX versions.
|
|
|
5
5
|
|
|
6
6
|
## Quickstart
|
|
7
7
|
|
|
8
|
-
Initialize a project and install the preset:
|
|
9
|
-
|
|
10
8
|
```sh
|
|
11
9
|
bunx @pathmx/core@beta init my-path
|
|
12
10
|
cd my-path
|
|
@@ -14,41 +12,4 @@ pmx plugins add paths
|
|
|
14
12
|
mv paths/index.md paths/index.path.md
|
|
15
13
|
```
|
|
16
14
|
|
|
17
|
-
|
|
18
|
-
repository Plugin entrypoint is needed.
|
|
19
|
-
|
|
20
|
-
Create `paths/index.path.md`:
|
|
21
|
-
|
|
22
|
-
```md
|
|
23
|
-
# My first Path
|
|
24
|
-
|
|
25
|
-
<x-player-app />
|
|
26
|
-
|
|
27
|
-
- [Introduction](./introduction.md)
|
|
28
|
-
- [Next steps](./next-steps.md)
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Create the two linked Sources:
|
|
32
|
-
|
|
33
|
-
```sh
|
|
34
|
-
echo '# Introduction' > paths/introduction.md
|
|
35
|
-
echo '# Next steps' > paths/next-steps.md
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Start PathMX:
|
|
39
|
-
|
|
40
|
-
```sh
|
|
41
|
-
pmx dev
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Optional packages
|
|
45
|
-
|
|
46
|
-
Authentication and Mermaid rendering remain explicit additions:
|
|
47
|
-
|
|
48
|
-
```sh
|
|
49
|
-
bun add @pathmx/auth@beta @pathmx/mermaid@beta
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Add each package through its own repository Plugin so its configuration stays
|
|
53
|
-
local to the application. Use `@pathmx/mermaid/beautiful` for the ready-to-use
|
|
54
|
-
Mermaid renderer.
|
|
15
|
+
[Setup and reference](https://pathmx.dev/docs/learning/paths.guide)
|
package/index.ts
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
import { createCompletionPlugin } from "@pathmx/completion"
|
|
2
|
-
import {
|
|
2
|
+
import { createPathPlugin } from "@pathmx/path"
|
|
3
3
|
import { PlayerPlugin } from "@pathmx/player"
|
|
4
4
|
import { definePreset } from "@pathmx/core"
|
|
5
5
|
|
|
6
6
|
/** The opinionated, provider-neutral Paths product baseline. */
|
|
7
|
-
|
|
8
|
-
(
|
|
9
|
-
()
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
PlayerPlugin,
|
|
15
|
-
])
|
|
7
|
+
const createPathsPlugins = () => {
|
|
8
|
+
const completion = createCompletionPlugin({ storage: "actor" })
|
|
9
|
+
const path = createPathPlugin({ completion: completion.reader })
|
|
10
|
+
return [completion.plugin, path.plugin]
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export const PathsPreset = definePreset([createPathsPlugins, PlayerPlugin])
|
|
16
14
|
|
|
17
15
|
export default PathsPreset
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pathmx/paths",
|
|
3
3
|
"description": "The provider-neutral Path, Completion, and Player experience for PathMX.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.6.0",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -24,11 +24,11 @@
|
|
|
24
24
|
"bun": ">=1.4.0"
|
|
25
25
|
},
|
|
26
26
|
"peerDependencies": {
|
|
27
|
-
"@pathmx/core": "^0.
|
|
27
|
+
"@pathmx/core": "^0.6.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@pathmx/completion": "0.
|
|
31
|
-
"@pathmx/path": "0.
|
|
32
|
-
"@pathmx/player": "0.
|
|
30
|
+
"@pathmx/completion": "0.6.0",
|
|
31
|
+
"@pathmx/path": "0.6.0",
|
|
32
|
+
"@pathmx/player": "0.6.0"
|
|
33
33
|
}
|
|
34
34
|
}
|