Skip to main content

Docusaurus POC Overview

This Proof of Concept (POC) demonstrates how Docusaurus v3 can be used as a Docs-as-Code platform for technical documentation.

It focuses on:

  • Markdown & MDX authoring
  • Code examples with syntax highlighting, line numbers, and copy‑to‑clipboard
  • Search with a local search index
  • PDF export of documentation
  • Responsive, accessible UI with dark/light mode
  • Dead link detection and CI/CD to GitHub Pages

What this POC shows​

  • A small documentation structure under docs/ with multiple pages
  • Sidebar and table of contents navigation
  • Built‑in Docusaurus components such as tabs and admonitions
  • A GitHub Actions workflow that builds and deploys the site
  • A Node.js script that uses Playwright to export docs to PDF

How to explore​

  • Use the left sidebar to navigate between Intro, Getting Started, Code Examples, and Accessibility.
  • Use the search bar in the navbar to search across docs and pages.
  • Try the theme toggle in the navbar to switch between light and dark mode.
  • Resize the browser window to see the mobile navigation drawer.

Proof it works​

  • Search proof: type DOCUSAURUS_SEARCH_PROOF_9D2C7 into the search bar. This token appears on this page.
  • PDF proof: open the exported PDF after deployment: Download PDF

DOCUSAURUS_SEARCH_PROOF_9D2C7