Wiki Ado Convert

作者 microsoft354361d83247MIT收錄於 2026年10月8日更新於 2026年10月8日

Converts VitePress/GFM wiki markdown to Azure DevOps Wiki-compatible format. Generates a Node.js build script that transforms Mermaid syntax, strips front matter, fixes links, and outputs ADO-compatible copies to dist/ado-wiki/.

AI 產生的概覽

產生一個 Node.js 指令碼,將 VitePress/GFM markdown 轉換為相容 Azure DevOps Wiki 的 markdown 副本。

功能
此技能指示代理產生一個 Node.js ESM 建置指令碼,把 VitePress/GFM wiki markdown 轉換成 Azure DevOps Wiki 相容格式。指令碼會移除 YAML front matter、將 Mermaid 程式碼圍欄轉為 ADO 的 ::: mermaid 區塊、把 flowchart 換成 graph、修正長箭頭與 br 標籤、將上層相對來源連結轉為純文字,並可選擇把 VitePress 容器指令轉成 ADO 提示引用區塊。轉換後的副本寫入 dist/ado-wiki/,同時複製圖片、產生 .order 檔案與合適的 index.md 落地頁,並印出轉換統計資料,原始檔案維持不變。
適用情境
當需要把 VitePress 或 GFM markdown wiki 發佈到 Azure DevOps Wiki,而現有 markdown 在該平台渲染異常時使用。適用於 Mermaid 圖表損壞、front matter 可見、上層相對連結失效或容器指令不受支援等情況。也適用於需要為 ADO 產生 wiki 落地頁與側邊欄排序檔案的情境。
執行需求
需要 Node.js,僅使用內建模組(node:fs/promises、node:path、node:url),沒有外部相依套件。代理必須先透過檢查 git remote 或詢問使用者來解析來源儲存庫脈絡。此技能本身不附帶指令碼,而是產生一個指令碼,並且需要存取 markdown 來源檔案以及可寫入的 dist/ado-wiki/ 輸出位置。

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:

  1. Check for git remote: Run git remote get-url origin
  2. Ask the user: "Is this a local-only repository, or do you have a source repository URL?"
    • Remote URL → store as REPO_URL, preserve linked citations in converted output
    • Local → preserve local citations as-is
  3. 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

IssueVitePress/GFMADO WikiFix
Mermaid code fences```mermaid ... ```::: mermaid ... :::Convert opening/closing fences
flowchart keywordflowchart TDgraph TDReplace flowchart with graph (preserve direction)
<br> in Mermaid labelsNode[Label<br>Text]Not supportedStrip <br> variants (replace with space)
Long arrows ---->A ---->BNot supportedReplace with -->
YAML front matter--- ... --- at file startRendered as visible raw textStrip entirely
Parent-relative source links[text](../../src/file.cs)Broken (wiki is separate)Convert to plain text
VitePress container directives::: tip / ::: warningNot supportedConvert to ADO alert blockquotes > [!TIP] / > [!WARNING]

MODERATE — May Not Render Optimally

IssueNotes
Mermaid style directivesADO'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 linkingLinks 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 (NOT flowchart), 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.

javascript
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 -->
javascript
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');}
3. Convert Parent-Relative Source Links

Convert [text](../path) to plain text. Preserves same-directory .md links and external URLs.

javascript
function convertSourceLinks(content) {  return content.replace(    /\[([^\]]*)\]\(\.\.\/[^)]*\)/g,    (match, linkText) => linkText  );}
4. Convert VitePress Container Directives (Optional)

Convert ::: tip / ::: warning / ::: danger to ADO alert blockquotes:

javascript
function convertContainerDirectives(content) {  // ::: tip → > [!TIP]  // ::: warning → > [!WARNING]  // ::: danger → > [!CAUTION]  // ::: info → > [!NOTE]  // closing ::: → (blank line)}

Script Main Flow

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}

Skip Directories

The script should skip: node_modules, .vitepress, .git, dist, build, out, target, and any non-documentation directories.

npm Script Integration

json
{  "scripts": {    "build:ado": "node scripts/build-ado-wiki.js"  }}

Verification Checklist

After the script runs, verify:

  1. File count in dist/ado-wiki/ matches source (minus skipped dirs)
  2. Zero ```mermaid fences remaining — all converted to ::: mermaid
  3. Zero flowchart keywords remaining — all converted to graph
  4. No YAML front matter in output files
  5. Parent-relative links converted to plain text
  6. Same-directory .md links preserved
  7. Directory structure preserved
  8. Non-markdown files (images, etc.) copied as-is
  9. index.md at 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

  1. If VitePress source has index.md: Transform it (strip front matter, strip VitePress hero/features blocks). If meaningful content remains, use it.
  2. If no meaningful content remains (empty after stripping, or only VitePress hero markup): Generate a proper landing page with:
    • Project title as # 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
  3. NEVER leave a placeholder — if index.md contains "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 .md extension, 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

來源與署名

來源:microsoft/skills位於.github/plugins/deep-wiki/skills/wiki-ado-convert提交354361d

授權條款: MIT

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架