How to Add Articles

Overview

This guide explains how to add new articles to the Industrial Docs documentation center.

Directory Structure

src/content/docs/
├── index.mdx              # Home page
├── guides/                # Guides directory
│   └── getting-started.md
├── best-practices/        # Best Practices directory
│   └── getting-started.md
└── en/                   # English version
    ├── index.mdx
    ├── guides/
    └── best-practices/

Steps to Add New Articles

1. Create a Markdown File

Create a new .md or .mdx file in the appropriate directory.

# Example: Create a new guide article
touch src/content/docs/guides/my-new-article.md

2. Write Frontmatter

Each document file needs frontmatter at the top:

---
title: Article Title
description: Article description (shown in search results)
---

3. Write Content

Write your documentation content using Markdown syntax.

## Heading

This is the body content.

### Subheading

- List item 1
- List item 2

4. Add English Version

Create the corresponding English article in the en directory:

# Example: Create English version for the new article
touch src/content/docs/en/guides/my-new-article.md

5. Verify

Run the build command to verify:

npm run build

Starlight Components

You can use Starlight’s built-in components to enhance your documentation:

Asides

:::tip
This is a tip
:::

:::note
This is a note
:::

:::caution
This is a caution
:::

Code Blocks

\`\`\`javascript
console.log('Hello World');
\`\`\`

Cards

import { Card, CardGrid } from '@astrojs/starlight/components';

<CardGrid>
  <Card title="Title">Content</Card>
</CardGrid>

Notes

Use hyphens - to separate words in filenames
title and description in frontmatter are required
It is recommended to create English versions for each Chinese article
Keep the paths consistent between Chinese and English articles