In this tutorial, you’ll learn how to create your first documentation page using DocuBase. By the end, you’ll have a fully functional documentation page with custom content and components.
What You’ll Build
You’ll create a documentation page that includes:
- Frontmatter metadata
- Markdown content
- Custom components like callouts and code blocks
Info
Make sure you have DocuBase installed and running before starting this tutorial. If not, follow the Getting Started guide first.
Tutorial
Create a new MDX file
Navigate to the src/content/docs/ directory and create a new file called my-first-page.mdx:
touch src/content/docs/my-first-page.mdxecho. > src\content\docs\my-first-page.mdxOr simply create the file using your code editor.
Add frontmatter
Every documentation page needs frontmatter at the top. Add the following to your new file:
---
title: My First Page
description: This is my first documentation page
order: 10
category: Getting Started
---The frontmatter fields are:
title: The page title (required)description: A brief description shown in listingsorder: Controls the sort order within a categorycategory: Groups related pages together
Add content
Below the frontmatter, add your Markdown content:
## Introduction
Welcome to my first documentation page! This is a great place to
explain what this section of documentation covers.
## Getting Started
Here's how to get started with this feature:
1. First, do this
2. Then, do that
3. Finally, you're done!
## Code Example
Here's a code example:
\`\`\`javascript
function greet(name) {
console.log(\`Hello, \${name}!\`);
}
greet('World');
\`\`\` Import and use components
Make your documentation more interactive by importing components. Add these imports after the frontmatter:
import Callout from '@/components/Callout.astro';
<Callout type="tip">
This is a helpful tip for your readers!
</Callout>You can use any of the built-in components:
Callout- For notes, tips, and warningsTabs- For tabbed content and code examplesStepsandStep- For sequential instructionsCollapsible- For expandable sections
Preview your page
If your development server is running, navigate to:
http://localhost:4321/docs/my-first-pageYou should see your new documentation page! If the server isn’t running, start it with:
npm run dev Complete Example
Here’s the complete example file for reference:
---
title: My First Page
description: This is my first documentation page
order: 10
category: Getting Started
---
import Callout from '@/components/Callout.astro';
## Introduction
Welcome to my first documentation page! This is a great place to
explain what this section of documentation covers.
<Callout type="tip">
This is a helpful tip for your readers!
</Callout>
## Getting Started
Here's how to get started with this feature:
1. First, do this
2. Then, do that
3. Finally, you're done!
## Code Example
Here's a code example:
\`\`\`javascript
function greet(name) {
console.log(\`Hello, \${name}!\`);
}
greet('World');
\`\`\`
Next Steps
Now that you’ve created your first documentation page, you can:
- Learn about all available Components
- Create a blog post
- Explore customization options
Note
Remember to commit your changes and push to your repository to see them in production!