OpenParable
Skip to content
← Back to skills

Va Md Preview

Documents
va-md-preview

Va Md Preview is an Agent Skill for documents published in the jazzenchen/VibeAround repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Codex only: preview a markdown file from a Codex session with beautiful GitHub-style rendering. Use after creating or updating markdown documents like README, docs, or reports. Only available when the VibeAround MCP server is connected.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/jazzenchen/VibeAround/blob/HEAD/src/skills/codex/va-md-preview/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/va-md-preview, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

VibeAround Markdown Preview

After you create or update a markdown document, generate a styled preview so the user can read it in their browser or phone with beautiful formatting.

When to Use

  • You just created or updated a README.md, documentation, or any .md file
  • The user asks to "show me the doc", "preview the README", or "let me see it"
  • Only when the VibeAround MCP server is connected

Proactive behavior: After creating or updating any markdown file, proactively ask the user if they'd like to preview it (e.g. "Want me to generate a preview link so you can see it?"). If the user confirms, call md_preview. Do NOT call the tool without asking first.

Prerequisites

The VibeAround MCP server must be connected (server name: vibearound). If not available, tell the user to start the VibeAround desktop app.

Steps

1. Call md_preview

Tool: md_preview
Server: vibearound
Arguments:
  file: "<path to the markdown file>"  (absolute or relative to cwd)
  cwd: "<current working directory>"
  title: "<document title>"  (optional, defaults to filename)

If the tool says the workspace is not registered, call register_workspace with the cwd first, then retry.

2. Present BOTH links to the user

The tool returns an Owner link and a Share link. Always show both in this format:

Markdown preview 已就绪：
- 你的预览: <owner_url>
- 分享链接: <share_url>（10 分钟有效）

Or in English:

Markdown preview ready:
- Owner: <owner_url>
- Share: <share_url> (expires in 10 min)

Never omit either link. The owner link is permanent. The share link is temporary and needs no auth.

Error Handling

  • MCP server not available: The VibeAround desktop app may not be running.
  • Workspace not registered: Call register_workspace first, then retry.
  • File not found: Verify the file path is correct and the file exists.