Switch from DocFX to MkDocs Material for documentation

[Jaben]

Replace DocFX (dated UI) with MkDocs Material (modern, dark mode, search, code copy). Same markdown content, much better presentation.

• Deep purple theme with light/dark mode toggle
• Admonition callouts for example links
• Code block copy buttons
• Navigation sections with instant loading
• Search with suggestions and highlighting
• GitHub Actions workflow updated for Python/MkDocs

Summary by CodeRabbit

• Documentation
  • Redesigned documentation site with improved navigation and visual presentation.
  • Reformatted examples and guides with enhanced readability.
  • Updated landing page with quick access to installation and configuration steps.
  • Removed the auto-generated API reference section.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7921e981-aa24-4e0c-9fd9-bf7e6f982bbe

📥 Commits

Reviewing files that changed from the base of the PR and between 50991a0 and 0f5782a.

📒 Files selected for processing (15)

• .github/workflows/docs.yml
• .gitignore
• docs/.gitignore
• docs/advanced-features.md
• docs/api/index.md
• docs/articles/toc.yml
• docs/docfx.json
• docs/getting-started.md
• docs/html-and-url-to-pdf.md
• docs/index.md
• docs/office-conversion.md
• docs/pdf-manipulation.md
• docs/screenshots.md
• docs/toc.yml
• mkdocs.yml

---

📝 Walkthrough

Walkthrough

The pull request migrates the documentation build system from DocFX to MkDocs Material. The GitHub Actions workflow is updated to use Python and install MkDocs Material instead of .NET and DocFX. Old DocFX configuration and API auto-generation files are removed. Documentation markdown files are reformatted with MkDocs-compatible admonition syntax, and the table of contents structure is simplified.

Changes

Cohort / File(s)	Summary
Documentation Build System .github/workflows/docs.yml, mkdocs.yml	Updated CI workflow to replace .NET/DocFX with Python/MkDocs Material toolchain; added comprehensive MkDocs configuration with Material theme, navigation structure, and Markdown extensions.
Configuration Cleanup docs/docfx.json, docs/articles/toc.yml, docs/api/index.md	Removed DocFX configuration file, emptied articles table of contents, and cleared API reference index in preparation for MkDocs-based documentation structure.
Git Ignore Configuration .gitignore, docs/.gitignore	Added site/ directory to root gitignore for MkDocs output; cleared all entries from docs-specific gitignore file.
Documentation Structure docs/toc.yml	Removed "Articles" and "API Reference" entries from main table of contents, streamlining navigation for new MkDocs-based site.
Documentation Content docs/index.md, docs/getting-started.md, docs/advanced-features.md, docs/html-and-url-to-pdf.md, docs/office-conversion.md, docs/pdf-manipulation.md, docs/screenshots.md	Reformatted "Examples" sections and other content blocks using MkDocs admonition syntax (e.g., !!! example) replacing inline markdown formatting; updated landing page with badge links and restructured Quick Start sections.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Add DocFX documentation site with GitHub Pages #76: Opposite direction migration adding DocFX-based documentation system, modifying same files (.github/workflows/docs.yml, docs/, docfx.json) but introducing DocFX instead of removing it.

Poem

🐰 Hopping from DocFX to MkDocs we go,
With Python and Material stealing the show,
No more C# tools, just pip install bliss,
Site builds in seconds—a productivity kiss! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/docfx-documentation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}