Skip to main content

Part 6: Create Documentation - The Whole Point

· One min read
Mike Stabile
Mike Stabile
AI Integration Specialist & Developer

We've spent six chapters preparing to integrate a React app into a documentation framework, and we haven't written a single line of documentation. Time to cook.

The Basics: Markdown​

Documentation in Docusaurus is Markdown files in the docs/ folder with frontmatter:

---
sidebar_position: 1
title: Welcome
---

The Magic: MDX​

MDX is Markdown with JSX. Import React components directly:

import ProviderCard from '@site/src/components/ProviderCard';

<ProviderCard provider={sampleProvider} />

This is the superpower Docusaurus offers. Show, don't just tell.

The Documentation Mindset​

Good documentation answers:

  1. What is this?
  2. Why should I care?
  3. How do I use it?

Next: Part 7 - Configure for Deployment: Preparing for Launch