@pathmx/paths 0.5.0 → 0.5.1
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 +23 -24
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
# `@pathmx/paths`
|
|
2
2
|
|
|
3
|
-
The provider-neutral Paths
|
|
4
|
-
|
|
5
|
-
installs those implementation packages at the matching PathMX release.
|
|
3
|
+
The provider-neutral Paths preset. One install adds Path semantics, Completion,
|
|
4
|
+
and Player at matching PathMX versions.
|
|
6
5
|
|
|
7
|
-
##
|
|
6
|
+
## Quickstart
|
|
8
7
|
|
|
9
|
-
Create a Bun project and install the
|
|
8
|
+
Create a Bun project and install the beta CLI plus the preset:
|
|
10
9
|
|
|
11
10
|
```sh
|
|
12
11
|
mkdir my-path && cd my-path
|
|
@@ -16,21 +15,29 @@ bun run pmx plugins add paths
|
|
|
16
15
|
mkdir -p paths plugins
|
|
17
16
|
```
|
|
18
17
|
|
|
19
|
-
Activate the preset
|
|
18
|
+
Activate the preset:
|
|
20
19
|
|
|
21
20
|
```ts
|
|
22
21
|
// plugins/paths.plugin.ts
|
|
23
22
|
export { default } from "@pathmx/paths"
|
|
24
23
|
```
|
|
25
24
|
|
|
26
|
-
Create `paths/index.md`:
|
|
25
|
+
Create `paths/index.path.md`:
|
|
27
26
|
|
|
28
27
|
```md
|
|
29
28
|
# My first Path
|
|
30
29
|
|
|
31
|
-
Welcome to PathMX.
|
|
32
|
-
|
|
33
30
|
<x-player-app />
|
|
31
|
+
|
|
32
|
+
- [Introduction](./introduction.md)
|
|
33
|
+
- [Next steps](./next-steps.md)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Create the two linked Sources:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
echo '# Introduction' > paths/introduction.md
|
|
40
|
+
echo '# Next steps' > paths/next-steps.md
|
|
34
41
|
```
|
|
35
42
|
|
|
36
43
|
Add project-local commands to `package.json`:
|
|
@@ -44,28 +51,20 @@ Add project-local commands to `package.json`:
|
|
|
44
51
|
}
|
|
45
52
|
```
|
|
46
53
|
|
|
47
|
-
|
|
54
|
+
Start PathMX:
|
|
48
55
|
|
|
49
56
|
```sh
|
|
50
57
|
bun run dev
|
|
51
58
|
```
|
|
52
59
|
|
|
53
|
-
|
|
60
|
+
## Optional packages
|
|
61
|
+
|
|
62
|
+
Authentication and Mermaid rendering remain explicit additions:
|
|
54
63
|
|
|
55
64
|
```sh
|
|
56
65
|
bun run pmx plugins add auth mermaid
|
|
57
66
|
```
|
|
58
67
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
import AuthPlugin from "@pathmx/auth"
|
|
63
|
-
import PathsPreset from "@pathmx/paths"
|
|
64
|
-
import { definePreset } from "@pathmx/core"
|
|
65
|
-
|
|
66
|
-
export default definePreset([AuthPlugin, PathsPreset])
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
Alternatively, keep Auth and Paths in separate repository plugin entrypoints.
|
|
70
|
-
Enable Beautiful Mermaid through `@pathmx/mermaid/beautiful`; it stays outside
|
|
71
|
-
the base preset because rendering diagrams has a meaningful build-time cost.
|
|
68
|
+
Add each package through its own repository Plugin so its configuration stays
|
|
69
|
+
local to the application. Use `@pathmx/mermaid/beautiful` for the ready-to-use
|
|
70
|
+
Mermaid renderer.
|
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.5.
|
|
4
|
+
"version": "0.5.1",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
"@pathmx/core": "^0.5.0"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@pathmx/completion": "0.5.
|
|
28
|
-
"@pathmx/path": "0.5.
|
|
29
|
-
"@pathmx/player": "0.5.
|
|
27
|
+
"@pathmx/completion": "0.5.1",
|
|
28
|
+
"@pathmx/path": "0.5.1",
|
|
29
|
+
"@pathmx/player": "0.5.1"
|
|
30
30
|
}
|
|
31
31
|
}
|