docs

How-to Guides

Pick a practical guide when you want one Markdown workspace task working in VS Code.

Choose a workflow

Start here when you want to do something concrete: install the extension, install the LLM skill/plugin, choose a Markdown flavor, enable structured profiles, fix a broken link, jump through a wiki link, rename a heading, or understand why an example is being ignored.

  • Install and activate the VS Code extension.
  • Install the LLM skill/plugin for Claude, Codex, or another compatible agent.
  • Choose Auto Detect or an explicit Markdown flavor.
  • Layer Keep a Changelog, Common Changelog, or MADR profiles on top of a base flavor.
  • Complete wiki-links and headings from notes in your vault.
  • Navigate notes, headings, blocks, embeds, and attachments.
  • Rename notes and headings safely without rewriting unrelated text.
  • Fix broken links with diagnostics and code actions.
Use the VS Code Extension Install and activate the Flavor Grenade VS Code extension for Markdown workspace workflows.Use the LLM Skill and Plugin Install the Flavor Grenade LSP skill/plugin so Claude, Codex, and compatible agents can inspect Markdown flavor evidence.Configure Markdown Workspaces Configure root detection, indexing boundaries, explicit flavor markers, and generated-output behavior.Choose a Markdown Flavor Use Auto Detect, project configuration, and the VS Code selector to choose the right base Markdown flavor.Use Structured Profiles Layer Keep a Changelog, Common Changelog, or MADR structure on top of the selected Markdown flavor.Fix Broken Links Use diagnostics to repair missing notes, headings, embeds, images, and attachments.Use Code Actions Apply Flavor Grenade quick fixes for missing files, table of contents updates, tags, and non-breaking spaces.Rename Notes Safely Rename notes and headings while preserving supported local references inside a vault.Complete Wiki-links and Headings Use vault-aware completion for notes, headings, tags, embeds, and attachments.Navigate Notes, Headings, Blocks, Embeds, and Attachments Jump from Obsidian-style references to local notes, anchors, embeds, and attachments.Find References and Highlights Find backlinks, outbound references, tag references, and repeated local references.Use Tags and Tag Completion Complete nested Obsidian tags and find tag references across indexed vault notes.Work with OFM Opaque Regions Understand why code, math, comments, frontmatter, and templates avoid false OFM tokens.

Workflow groups

Setup guides are the best first stop. After that, choose the page that matches the work in front of you: flavors, structured profiles, links, navigation, rename, diagnostics, tags, code actions, or examples that should stay quiet inside code and template regions.