@markstanden/opencode-docs-plugin 0.2.0 → 0.2.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 +43 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,6 +17,49 @@ configured docs root's `*.md` files (the `root` plugin option; default
|
|
|
17
17
|
|
|
18
18
|
Reading a matched doc stays OpenCode's built-in `read`.
|
|
19
19
|
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
From npm:
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
opencode plugin add @markstanden/opencode-docs-plugin
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
or as a `plugins` entry in `opencode.json(c)` (global, project or `.opencode/`):
|
|
29
|
+
|
|
30
|
+
```jsonc
|
|
31
|
+
{
|
|
32
|
+
"$schema": "https://opencode.ai/config.json",
|
|
33
|
+
"plugins": ["@markstanden/opencode-docs-plugin"],
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Unpinned entries update on the next server start or `opencode plugin update`;
|
|
38
|
+
an exact version (e.g. `@0.2.0`) stays pinned.
|
|
39
|
+
|
|
40
|
+
## Configuration
|
|
41
|
+
|
|
42
|
+
The docs root defaults to `<location>/docs`. Set the `root` option with the
|
|
43
|
+
object form — `~` expands against the home directory, so a global config can
|
|
44
|
+
point every project at one shared tree:
|
|
45
|
+
|
|
46
|
+
```jsonc
|
|
47
|
+
{
|
|
48
|
+
"$schema": "https://opencode.ai/config.json",
|
|
49
|
+
"plugins": [
|
|
50
|
+
{
|
|
51
|
+
"package": "@markstanden/opencode-docs-plugin",
|
|
52
|
+
"options": {
|
|
53
|
+
"root": "~/doclake",
|
|
54
|
+
},
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Relative paths resolve against the location's directory; absolute paths pass
|
|
61
|
+
through. Restart OpenCode after editing the config — it isn't hot-reloaded.
|
|
62
|
+
|
|
20
63
|
## Status
|
|
21
64
|
|
|
22
65
|
Standalone extract of the docs tooling, under active development.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@markstanden/opencode-docs-plugin",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "OpenCode V2 plugin: a `docs` tool and `/docs` command over a repository's knowledge tree, with the writing convention it owns",
|
|
6
6
|
"repository": {
|