markdown-formatting ยท diff
git:20260214.87ff913 to git:20261019.6910e74
14 added, 0 removed. Audit A to A.
---
description: Markdown link conventions and code formatting for docs, blog posts, and rule files
globs: **/*.md, **/*.mdc, **/*.mdx
alwaysApply: false
---
# Markdown Formatting
## Documentation Links
Link API concepts that have corresponding doc pages:
- **External doc links**: `[Union](https://dataclient.io/rest/api/Union)`
- **Internal doc links**: Use site paths like `[Controller](/docs/api/Controller)` or `[Entity](/rest/api/Entity)`
- **Package links**: `[@data-client/rest](www.npmjs.com/package/@data-client/rest)`
## Repository Links
- **PR links**: `[#1234](https://github.com/reactive/data-client/pull/1234)`
- **Commit links**: ``[`abc123`](https://github.com/reactive/data-client/commit/abc123)``
## Code References
- Use backticks for inline code: function names, class names, file paths, package names
- Use fenced code blocks with language tags for multi-line code examples
+ ## Terminal Commands vs Agent Prompts
+
+ The fence language tells readers where a snippet goes; the site styles each one to match.
+
+ | Snippet | Fence | In JSX |
+ |---|---|---|
+ | Shell command, including agent CLIs (`claude plugin install`) | ` ```bash ` | `<CodeBlock className="language-bash">` |
+ | Typed into the agent's chat: prompts, skills (`/data-client-setup`), agent slash commands (`/add-plugin`) | ` ```prompt ` | `<AgentPrompt prompt="..." />` |
+
+ - Write commands bare, without `$ ` or `title="bash"`: the site already adds an uncopied `$` to each command.
+ - A prompt only one agent understands gets `title="Cursor"` (fence meta or prop).
+ - Lead each block with where it goes ("Then run it in your agent's chat:"), so READMEs, where GitHub shows `prompt` unstyled, still read right.
+ - `framed` (` ```bash framed `, `<SkillTabs framed />`, `<AgentPrompt framed />`) adds "Terminal" / "Agent chat" headers; use it on getting-started steps that alternate the two.
+