Skip to content

Semantic Markdown 3.0.0

Choose a tag to compare

@github-actions github-actions released this 05 Nov 12:31
· 17 commits to main since this release
1798942

Downloads

Asset What it is How to install
semantic-markdown-3.0.0.vsix VS Code extension code --install-extension semantic-markdown-3.0.0.vsix, or Extensions → ⋯ → Install from VSIX… (guide)
semantic-markdown-3.0.0.tgz npm package (library + smd CLI), the same file as on npm npm install -g ./semantic-markdown-3.0.0.tgz
semantic-markdown-writer.zip Agent skill: create and edit .smd following the rules Unzip into ~/.claude/skills/ or upload in Claude → Settings → Capabilities → Skills (guide)
semantic-markdown-reader.zip Agent skill: token-efficient reading Same as above
semantic-markdown-playground.zip Web playground: edit, preview and share .smd in the browser Unzip and open playground/index.html, or serve the folder (guide)
mkdocs_semantic_markdown-3.0.0-py3-none-any.whl MkDocs plugin (Python wheel; needs Node.js 22+) pip install ./mkdocs_semantic_markdown-3.0.0-py3-none-any.whl (guide)
mkdocs_semantic_markdown-3.0.0.tar.gz MkDocs plugin source distribution pip install ./mkdocs_semantic_markdown-3.0.0.tar.gz
semantic-markdown-obsidian-3.0.0.zip Obsidian plugin (a styled-markdown folder, the plugin's ID, with main.js, manifest.json and styles.css) Unzip into your vault's .obsidian/plugins/, then turn it on in Settings → Community plugins (guide)
semantic-markdown-jetbrains-3.0.0.zip JetBrains plugin (IntelliJ IDEA 2025.3+, PyCharm, WebStorm…): highlighting and the language server; needs Node.js 22+ Settings → Plugins → ⚙ → Install Plugin from Disk… (guide)

Styled Markdown is now Semantic Markdown. The name says what the format is for: Markdown whose decisions, risks, tasks and agent instructions tools can read. The format doesn't change. .smd files, the smd command and its flags, smd: 2, the smd.* settings, commands and keybindings, diagnostic codes and the smd-* CSS classes all stay the same, so documents, CI checks and editor setups keep working. What changes are the published names. Each old name gets one last 3.0.0 release that moves you to the new one. See Moving from Styled Markdown.

⚠️ Breaking changes

  • The VS Code extension is bislink360.semantic-markdown (was bislink360.styled-markdown), on the Marketplace and Open VSX. The old ID's 3.0.0 update installs the new extension and offers to uninstall itself. While the full 2.x extension is still enabled, the new one stays idle and asks you to uninstall the old one, because both register the same commands. Migration: nothing for most users. Settings, keybindings and .vscode/extensions.json recommendations that name bislink360.styled-markdown should name bislink360.semantic-markdown.
  • The npm package is semantic-markdown (was styled-markdown). Imports move with it: semantic-markdown, semantic-markdown/markdown-it, /remark, /rehype, /smd.css, /frontmatter.schema.json. The smd and smd-language-server commands are the same, and npx semantic-markdown runs the CLI. styled-markdown@3.0.0 is the same code under the old name (with npx styled-markdown still working) and is deprecated. Migration: npm uninstall styled-markdown && npm install semantic-markdown, then replace styled-markdown with semantic-markdown in imports.
  • The MkDocs plugin is mkdocs-semantic-markdown on PyPI (was mkdocs-styled-markdown), with the module mkdocs_semantic_markdown. The plugin is still registered as styled-markdown next to its new name semantic-markdown, so mkdocs.yml keeps working. mkdocs-styled-markdown==3.0.0 only installs the new package. Migration: pip install mkdocs-semantic-markdown, and rename the plugin in mkdocs.yml when convenient.
  • The agent skills are semantic-markdown-reader and semantic-markdown-writer (were styled-markdown-reader and -writer), and so are their release zips. smd skills install and smd init --agent claude remove the old copies they installed, so an agent never loads both. A folder whose SKILL.md was edited is kept and named in the output. Migration: re-run smd skills install (or --global).
  • Instruction files and markers for other agents are renamed: .cursor/rules/semantic-markdown.mdc, .github/instructions/semantic-markdown.instructions.md, and <!-- semantic-markdown:start --> … <!-- semantic-markdown:end --> in AGENTS.md. smd skills install --target … replaces the old section and removes the old files it generated, and keeps any you edited by hand. Migration: re-run smd skills install --target cursor,copilot,agents (the targets you use).
  • The MCP server is semantic-markdown in .mcp.json, .cursor/mcp.json and .vscode/mcp.json (was styled-markdown), and in the MCP registry (io.github.bislink360/semantic-markdown). smd init --agent … replaces an old styled-markdown entry that runs the bundled CLI. Its tools are now mcp__semantic-markdown__… in Claude Code. Migration: re-run smd init --agent …, and update permission rules that name mcp__styled-markdown__….
  • The Claude Code plugin and its marketplace are semantic-markdown (were styled-markdown). Migration: /plugin marketplace add bislink360/semantic-markdown, then /plugin install semantic-markdown@semantic-markdown, and remove the old one.
  • The repository is github.com/bislink360/semantic-markdown. GitHub redirects the old repository URL, clones and uses: bislink360/styled-markdown/validate@…, but the website moves to bislink360.github.io/semantic-markdown and the old address doesn't redirect. Release files are named semantic-markdown-X.Y.Z.vsix, semantic-markdown-X.Y.Z.tgz, semantic-markdown-playground.zip, mkdocs_semantic_markdown-…, semantic-markdown-obsidian-X.Y.Z.zip and semantic-markdown-jetbrains-X.Y.Z.zip. Migration: update download scripts and uses: lines when convenient.

Changed

  • Semantic Markdown everywhere you read the name: the docs, the spec, the website, the playground, templates, skills, editor commands and messages, and the store listings. The JetBrains plugin (ID com.bislink360.styled-markdown) and the Obsidian plugin (ID styled-markdown) keep their IDs, so they update in place and keep their settings. Only their names change.