You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](../docs/features/config-transparency.md)
84
84
-[Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](../docs/features/cross-file-integrity.md)
85
85
-[`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](../docs/features/dependency-graph.md)
86
-
-[A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](../docs/features/editor-agent-integration.md)
86
+
-[A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](../docs/features/editor-agent-integration.md)
87
87
-[Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](../docs/features/file-kinds-schemas.md)
88
88
-[A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](../docs/features/git-native.md)
89
89
-[The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](../docs/features/index.md)
-[Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
90
90
-[Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
91
91
-[`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
92
-
-[A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
92
+
-[A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
93
93
-[Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
94
94
-[A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
95
95
-[The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)
-[Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
76
76
-[Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
77
77
-[`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
78
-
-[A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
78
+
-[A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
79
79
-[Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
80
80
-[A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
81
81
-[The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)
A bundled VS Code extension and Claude Code plugins drive the same
5
-
`mdsmith lsp` server, so diagnostics, fix-on-save, and navigation
6
-
reach your editor and your coding agent unchanged.
4
+
A VS Code extension and Claude Code plugins run the same rule
5
+
engine, so diagnostics, quick-fixes, and navigation reach your
6
+
editor and your agent.
7
7
icon: plug
8
8
link: "/guides/editors/vscode/"
9
9
weight: 4
10
10
group: "One engine, every surface"
11
11
---
12
12
# Editors and agents
13
13
14
-
The rule engine is the same everywhere. The value is getting it
15
-
into the tools you already use without a separate config.
14
+
mdsmith runs one rule engine everywhere. The check that gates a
15
+
merge in CI is the same one your editor shows you. Your coding
16
+
agent sees that same check as it edits your Markdown. No second
17
+
config, no second ruleset.
16
18
17
19
<?include
18
20
file: ../brand/messaging.md
@@ -21,18 +23,43 @@ extract: vscode-overview.text
21
23
The extension is a thin LSP client over the bundled mdsmith binary, which it runs with the lsp subcommand. Diagnostics appear inline as squiggles, and every fixable rule contributes a lightbulb quick fix. A whole-buffer fix action runs on demand or on save, with an optional Refactor Preview before edits land. Cross-file navigation extends to Go to Definition, Find All References, workspace symbol search, and a call hierarchy across includes, catalogs, builds, and Markdown links. The mdsmith Command Palette runs Initialize Config, Fix All Markdown, Install Git Merge Driver, Explain Rule on This File, and Show Resolved Config. The .vsix bundles the mdsmith binary for every supported OS and architecture, so no separate install is needed.
22
24
<?/include?>
23
25
24
-
The same `.vsix` is published to Open VSX, so Cursor, VSCodium,
25
-
Theia, and Gitpod install it too.
26
+
The same `.vsix` ships on Open VSX, so Cursor, VSCodium, Theia,
27
+
and Gitpod install it too. The
28
+
[Obsidian plugin](../guides/editors/obsidian.md) runs the engine
29
+
as WebAssembly, on desktop and mobile.
26
30
27
-
The Claude Code plugin marketplace ships `mdsmith-lsp`, which
28
-
feeds the same diagnostics and navigation to the agent, plus a
29
-
Markdown-organization audit skill. The agent sees mdsmith inline
30
-
while it edits your docs.
31
+
In Claude Code, mdsmith shows the agent the same diagnostics CI
32
+
runs: broken links, missing anchors, and heading or schema
33
+
violations. The agent catches and fixes them as it writes, before
34
+
the change reaches your review.
31
35
32
-
Pair the plugin with the [progressive disclosure
33
-
guide](../guides/progressive-disclosure.md): a `<?catalog?>`
34
-
keeps `CLAUDE.md` a one-line-per-doc index of your docs tree.
36
+
The marketplace ships five plugins. `mdsmith-lsp` gives the agent
37
+
inline diagnostics and the navigation the editor gets.
38
+
`mdsmith-autofix` runs `mdsmith fix` after every Markdown edit, so
39
+
generated sections and formatting stay correct with no manual
40
+
step. Three slash commands run the CLI from the prompt:
41
+
`/mdsmith-fix`, `/mdsmith-check`, and `/mdsmith-kinds`. A
42
+
`markdown-reviewer` subagent reviews Markdown PRs and drafts for
43
+
structural drift. The `/markdown-audit` skill audits a
44
+
repository's file layout: hand-kept indexes, missing kinds, and
45
+
absent schemas.
35
46
36
-
See the [VS Code guide](../guides/editors/vscode.md), the
37
-
[Obsidian guide](../guides/editors/obsidian.md), and the
38
-
[install guide](../guides/install.md) for setup.
47
+
Register the marketplace once, then install the plugins you want:
48
+
49
+
```text
50
+
/plugin marketplace add jeduden/mdsmith
51
+
```
52
+
53
+
The [install guide](../guides/install.md#claude-code-plugins)
54
+
lists the per-plugin install commands and prerequisites. mdsmith
55
+
makes no network call of its own; each plugin only runs the local
56
+
binary (see the [telemetry policy](../reference/telemetry.md)).
57
+
58
+
Pair the plugins with
59
+
[progressive disclosure](../guides/progressive-disclosure.md). A
60
+
`<?catalog?>` in `CLAUDE.md` keeps one summary line per tracked
61
+
doc. The agent reads that index up front, then opens only the
62
+
files a task touches.
63
+
64
+
See the [VS Code guide](../guides/editors/vscode.md) and the
65
+
[Obsidian guide](../guides/editors/obsidian.md) for editor setup.
0 commit comments