ADO Wiki Converter
Generate a Node.js build script that transforms VitePress/GFM markdown documentation into Azure DevOps Wiki-compatible format. The source files remain untouched — the script produces transformed copies in dist/ado-wiki/.
Source Repository Resolution (MUST DO FIRST)
Before generating the build script, resolve the source repository context:
- Check for git remote: Run
git remote get-url origin - Ask the user: _"Is this a local-only repository, or do you have a source repository URL?"_
REPO_URL, preserve linked citations in converted output
- Local → preserve local citations as-is
- Do NOT proceed until resolved
Why This Is Needed
Azure DevOps Wikis use a markdown dialect that differs from GFM and VitePress in several critical ways. Documentation that renders perfectly in VitePress will have broken diagrams, raw front matter, dead links, and rendering issues when published as an ADO Wiki.
ADO Wiki Incompatibilities
CRITICAL — Will Break Rendering
| Issue | VitePress/GFM | ADO Wiki | Fix |
| Mermaid code fences | `mermaid ... ` | ::: mermaid ... ::: | Convert opening/closing fences |
flowchart keyword | flowchart TD | graph TD | Replace flowchart with graph (preserve direction) |
<br> in Mermaid labels | Node[Label<br>Text] | Not supported | Strip <br> variants (replace with space) |
Long arrows ----> | A ---->B | Not supported | Replace with --> |
| YAML front matter | --- ... --- at file start | Rendered as visible raw text | Strip entirely |
| Parent-relative source links | [text](../../src/file.cs) | Broken (wiki is separate) | Convert to plain text |
| VitePress container directives | ::: tip / ::: warning | Not supported | Convert to ADO alert blockquotes > [!TIP] / > [!WARNING] |
MODERATE — May Not Render Optimally
| Issue | Notes |
Mermaid style directives | ADO's Mermaid version may ignore inline styling. Leave as-is (cosmetic). |
Mermaid thick arrows ==> | May work. Leave as-is. |
Mermaid dotted arrows -.-> | May work. Leave as-is. |
| Subgraph linking | Links to/from subgraphs not supported, but nodes inside subgraphs work fine. |
NOT AN ISSUE (Compatible As-Is)
- ✅ Standard markdown tables, blockquotes, horizontal rules
- ✅ Unicode emoji, fenced code blocks with language identifiers
- ✅ Same-directory relative links (
./other-page.md) - ✅ External HTTP/HTTPS links
- ✅ Bold, italic, strikethrough, inline code
- ✅ Lists (ordered, unordered, nested), headings 1-6
- ✅ Images with relative paths
ADO Wiki Mermaid Supported Diagram Types
As of 2025:
- ✅
sequenceDiagram,gantt,graph(NOTflowchart),classDiagram - ✅
stateDiagram,stateDiagram-v2,journey,pie,erDiagram - ✅
requirementDiagram,gitGraph,timeline - ❌
mindmap,sankey,quadrantChart,xychart,block
Build Script Structure
The generated script should be a Node.js ESM module (scripts/build-ado-wiki.js) using only built-in Node.js modules (node:fs/promises, node:path, node:url). No external dependencies.
Transformation Functions
1. Strip YAML Front Matter
Remove --- delimited YAML blocks at file start. ADO renders these as visible text.
function stripFrontMatter(content) {
if (!content.startsWith('---')) return content;
const endIndex = content.indexOf('\n---', 3);
if (endIndex === -1) return content;
let rest = content.slice(endIndex + 4);
if (rest.startsWith('\n')) rest = rest.slice(1);
return rest;
}
2. Convert Mermaid Blocks
Process line-by-line, tracking mermaid block state. Apply fixes ONLY inside mermaid blocks:
- Opening:
`mermaid→::: mermaid - Closing:
`→::: flowchart→graph(preserve direction: TD, LR, TB, RL, BT)- Strip
<br>,<br/>,<br />(replace with space) - Replace long arrows (
---->with 4+ dashes) with-->
function convertMermaidBlocks(content) {
const lines = content.split('\n');
const result = [];
let inMermaid = false;
for (const line of lines) {
const trimmed = line.trimEnd();
if (!inMermaid && /^mermaid\s*$/.test(trimmed)) {
result.push('::: mermaid');
inMermaid = true;
continue;
}
if (inMermaid && /^``\s*$/.test(trimmed)) {
result.push(':::');
inMermaid = false;
continue;
}
if (inMermaid) {
let fixed = line;
fixed = fixed.replace(/^(\s*)flowchart(\s+)/, '$1graph$2');
fixed = fixed.replace(/<br\s*\/?>/gi, ' ');
fixed = fixed.replace(/-{4,}>/g, '-->');
result.push(fixed);
} else {
result.push(line);
}
}
return result.join('\n');
}
__CODE_BLOCK_2__javascript
function convertSourceLinks(content) {
return content.replace(
/\[([^\]]*)\]\(\.\.\/[^)]*\)/g,
(match, linkText) => linkText
);
}
__CODE_BLOCK_3__javascript
function convertContainerDirectives(content) {
// ::: tip → > [!TIP]
// ::: warning → > [!WARNING]
// ::: danger → > [!CAUTION]
// ::: info → > [!NOTE]
// closing ::: → (blank line)
}
__CODE_BLOCK_4__javascript
async function main() {
const files = await collectMarkdownFiles(ROOT);
const stats = { frontMatter: 0, mermaid: 0, sourceLinks: 0, containers: 0 };
for (const filePath of files) {
let content = await readFile(filePath, 'utf-8');
content = stripFrontMatter(content);
content = convertMermaidBlocks(content);
content = convertSourceLinks(content);
const outPath = join(OUTPUT, relative(ROOT, filePath));
await mkdir(dirname(outPath), { recursive: true });
await writeFile(outPath, content, 'utf-8');
}
// Print transformation statistics
}
__CODE_BLOCK_5__json
{
"scripts": {
"build:ado": "node scripts/build-ado-wiki.js"
}
}
__CODE_BLOCK_6__mermaid fences remaining — all converted to ::: mermaid
- Zero
flowchartkeywords remaining — all converted tograph - No YAML front matter in output files
- Parent-relative links converted to plain text
- Same-directory
.mdlinks preserved - Directory structure preserved
- Non-markdown files (images, etc.) copied as-is
index.mdat root is a proper wiki home page (NOT a placeholder)
Index Page Generation (CRITICAL)
The ADO Wiki's index.md MUST be a proper wiki landing page, NOT a generic placeholder with "TODO" text.
Logic
- If VitePress source has
index.md: Transform it (strip front matter, strip VitePress hero/features blocks). If meaningful content remains, use it. - If no meaningful content remains (empty after stripping, or only VitePress hero markup): Generate a proper landing page with:
# heading
- Overview paragraph (from README or wiki overview page)
- Quick Navigation table (Section, Description columns linking to wiki sections)
- Links to onboarding guides if they exist
- NEVER leave a placeholder — if
index.mdcontains "TODO:", "Give a short introduction", or similar placeholder text, replace it entirely
ADO Wiki .order Files
Generate .order files in each directory to control sidebar ordering:
- Onboarding guides first, then numbered sections
- List page names without
.mdextension, one per line
Citation & Diagram Preservation
The converted ADO wiki must maintain the same quality standards:
- Linked citations (
[file:line](URL)) are standard markdown — preserve them as-is <!-- Sources: ... -->comment blocks after Mermaid diagrams — preserve (HTML comments work in ADO)- Tables with "Source" columns — preserve as-is (standard markdown tables)
- Mermaid diagrams — convert fences only; diagram content, types, and structure are preserved
- All Mermaid diagram types supported by ADO (graph, sequenceDiagram, classDiagram, stateDiagram, erDiagram, etc.) pass through unchanged
Important Notes
- Source files are NEVER modified — only copies in
dist/ado-wiki/ - Images must be copied too — if source has images, copy them with same relative paths
- The script should work with any VitePress wiki, not just this specific one
- Print statistics at the end showing count of each transformation type
- Script uses zero external dependencies — only Node.js builtins
Skill Information
- Source
- Microsoft
- Category
- Documents & Content
- Repository
- View on GitHub
Related Skills
wiki-agents-md
Generates AGENTS.md files for repository folders — coding agent context files with build commands, testing instructions, code style, project structure, and boundaries. Only generates where AGENTS.md is missing.
Microsoftwiki-architect
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.
Microsoftwiki-changelog
Analyzes git commit history and generates structured changelogs categorized by change type. Use when the user asks about recent changes, wants a changelog, or needs to understand what changed in the repository.
Microsoftwiki-llms-txt
Generates llms.txt and llms-full.txt files for LLM-friendly project documentation following the llms.txt specification. Use when the user wants to create LLM-readable summaries, llms.txt files, or make their wiki accessible to language models.
Microsoftwiki-onboarding
Generates four audience-tailored onboarding guides in an onboarding/ folder — Contributor, Staff Engineer, Executive, and Product Manager. Use when the user wants onboarding documentation for a codebase.
Microsoft