Commands Reference
All commands are invoked as writechoice <command> (or the shorter wcc <command>). Use this page as a quick reference — click any command to go to its full documentation.
Scrape
| Command | Description |
|---|---|
writechoice scrape | Scrapes documentation URLs and converts each page into an MDX file ready for Mintlify |
Check
| Command | Description |
|---|---|
writechoice check links | Validates internal links and anchors in MDX documentation files using browser automation |
writechoice check parse | Validates MDX files for parsing errors using the official @mdx-js/mdx compiler |
writechoice check images | Validates that all images on your deployed documentation pages load successfully |
writechoice check pages | Validates that every page listed in docs.json navigation loads successfully |
writechoice check katex | Finds pages with KaTeX render errors by scanning for .katex-error elements in the live HTML |
Fix
| Command | Description |
|---|---|
writechoice fix links | Automatically fixes broken anchor links in MDX files based on check links reports |
writechoice fix parse | Automatically fixes common MDX parsing errors in documentation files |
writechoice fix images | Wraps standalone images in <Frame> components in MDX files |
writechoice fix inlineimages | Converts images inline within text to <InlineImage> components |
writechoice fix h1 | Removes duplicate H1 headings that repeat the frontmatter title field |
writechoice fix imports | Validates and adds missing import statements for JSX components used in MDX files |
writechoice fix redirects | Replaces stale source paths with destination paths inside MDX files based on docs.json redirects |
writechoice fix tabs | Converts code-only <Tabs> groups into <CodeGroup> components |
writechoice fix codeblocks | Adjusts code block flags (expandable, lines, wrap) in MDX files |
writechoice fix void-tags | Self-closes HTML void tags (img, br, hr, ...) so MDX compiles as valid JSX |
writechoice fix accordions | Wraps runs of 2+ sibling <Accordion> blocks in <AccordionGroup> |
writechoice fix og-description | Renames frontmatter description to og:description |
writechoice fix dollar-signs | Escapes a bare $ before a digit in prose, skipping code and LaTeX math |
Find
| Command | Description |
|---|---|
writechoice find redirects | Probes broken links for HTTP redirects and writes a redirects JSON file |
Readme
| Command | Description |
|---|---|
writechoice readme convert | Converts readme.com markdown exports to Mintlify MDX |
writechoice readme recipes | Converts legacy recipe .md files into <RequestExample>/<ResponseExample>/<Steps> MDX |
writechoice readme openapi | Extracts inline # OpenAPI definition blocks into Mintlify openapi frontmatter |
writechoice readme openapi-dedupe | Comments out page bodies that duplicate their OpenAPI operation's description |
writechoice readme nav | Scrapes a readme.io sidebar and converts it to Mintlify navigation JSON |
Nav
| Command | Description |
|---|---|
writechoice nav folders | Restructures MDX files on disk to match the navigation hierarchy defined in docs.json |
writechoice nav root | Promotes matching group index pages to a root key in docs.json |
Docusaurus
| Command | Description |
|---|---|
writechoice docusaurus convert | Converts a Docusaurus docs folder to Mintlify-ready MDX files |
writechoice docusaurus slugify | Renames files so their paths match the slug or id in their frontmatter |
writechoice docusaurus nav | Converts a Docusaurus sidebars.js file into Mintlify navigation JSON |
Other
| Command | Description |
|---|---|
writechoice metadata | Fetches meta tags from live documentation pages and writes them into MDX frontmatter |
writechoice session | Captures an authenticated browser session for use with writechoice scrape |
writechoice config | Generates a config.json template file with all available configuration options |
writechoice update | Updates the CLI to the latest version from npm |