git404hub

what is mdx-tsc fr?

hipstersmoothie/mdx-tsc — explained in plain English

Analysis updated 2026-05-18

11TypeScriptAudience · developerComplexity · 2/5LicenseSetup · easy

tl;dr

A type checking tool and VS Code extension that catches errors in MDX files, which mix Markdown with React components.

vibe map

mindmap
  root((mdx-tsc))
    What it does
      Type checks MDX files
      CLI plus language server
      VS Code diagnostics
    Tech stack
      TypeScript
      pnpm
      VS Code extension
    Use cases
      Catch MDX type errors
      Inline editor diagnostics
      CI type checking
    Audience
      Developers
      Documentation authors

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Catch type errors in MDX files before they reach production.

VIBE 2

Get inline diagnostics for MDX frontmatter and components inside VS Code.

VIBE 3

Run type checking on MDX documentation as part of a build or CI pipeline.

what's the stack?

TypeScriptpnpmVS Code

how it stacks up fr

hipstersmoothie/mdx-tsc1476989162/vue-bill-print1e3pm/knowledge-chatbot
Stars111111
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasyeasymoderate
Complexity2/52/53/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · easy time til it works · 5min

Requires pnpm to build, the VS Code extension is additive and needs the official MDX extension installed alongside it.

in plain english

mdx-tsc brings type checking to MDX files, which are documents that mix regular Markdown text with embedded React components. Normal TypeScript tooling checks JavaScript and TypeScript code but does not understand MDX, so this project fills that gap. It works like the standard TypeScript compiler's command line tool, but for MDX, and it also ships a language server and a Visual Studio Code extension so problems show up directly in the editor. This repository is a monorepo containing three packages. The core one, called mdx-tsc, provides the command line tool and the language server, and is the place to start for anyone wanting to learn how to use it. The second package is the VS Code extension, which adds type and frontmatter warnings on top of the official MDX extension rather than replacing it, so both are meant to be installed together. The third package is a small playground project meant for trying the tool out inside an editor. The full usage documentation, including command line options, frontmatter schema details, and how to set up the editor, lives in the core package's own README rather than this top level one. To work on the project itself, you install dependencies and can build every package, run the test suite, lint the code, or format it, all through simple commands. To try the VS Code extension while developing, you can launch a special debug session that builds everything and opens the playground project in a separate development instance of the editor. Releases are done by hand rather than through an automated pipeline. Only the core mdx-tsc package is published to npm, versioned using a tool called changesets that tracks changes and bumps version numbers, while the VS Code extension is packaged into a file and uploaded to the Marketplace manually. The playground package stays private and is never published. The project is released under the MIT license, which allows free use, modification, and distribution, including for commercial purposes, as long as the original copyright notice is kept.

prompts (copy fr)

prompt 1
Help me set up mdx-tsc alongside the official MDX extension in VS Code.
prompt 2
Explain what problems mdx-tsc catches that regular TypeScript checking misses in MDX files.
prompt 3
Walk me through building and testing the mdx-tsc monorepo locally.
prompt 4
Show me how to publish a new version of the mdx-tsc npm package using changesets.

Frequently asked questions

what is mdx-tsc fr?

A type checking tool and VS Code extension that catches errors in MDX files, which mix Markdown with React components.

What language is mdx-tsc written in?

Mainly TypeScript. The stack also includes TypeScript, pnpm, VS Code.

How hard is mdx-tsc to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is mdx-tsc for?

Mainly developer.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.