#VPS.Town 社区内容贡献指南

#投稿流程

#1. 选题准备

在开始撰写投稿内容前，建议先确定好文章的主题和方向。VPS.Town 欢迎以下类型的内容：

• VPS.Town 产品使用教程与最佳实践
• 基于 VPS.Town 产品的应用搭建教程
• VPS、Linux、Docker、网络等相关的技术经验分享
• 云服务器应用场景与解决方案
• VPS.Town 最新活动创意与反馈

请确保您的内容主题符合 VPS.Town 社区文章投稿及奖励规则 中的相关要求。

#2. 内容编写

#硬性规范要求

1. 使用 MDX ( .mdx ) 格式撰写文章，MDX 完全兼容 Markdown 语法，只是后缀名需要改为 .mdx 。
2. 文章有效字数 (不包含代码，但包含图片和代码中的注释) 应不少于 200 字。
3. 内容应具有原创性、实用性和可操作性，并确保命令、代码片段经过测试，能够正常运行，并注明适用的环境信息。
4. 应 严格遵守文章排版结构，具体请参阅 此章节 。
5. 如文中有图片，请使用相对路径，并打包为 zip 压缩包，不要使用图床、绝对路径等服务。
6. 我们并不排斥任何 AI 辅助写作，但请您的稿件不要出现大量 AI 生成的内容，感谢您的理解。
7. 遇到中英文混排的情况，需要在中文和英文/数字之间添加空格，例如：

这是一段含有中文和English的中英混排文本，并自2025年4月12日发布于VPS.Town文档中心。

应修改为：

这是一段含有中文和 English 的文本，并自 2025 年 4 月 12 日发布于 VPS.Town 文档中心。

#建议性行文规范

以下为建议性行文规范，您可以参考以下规范来撰写文章：

1. 文章中应包含完整的操作步骤，避免跳跃性的说明。
2. 关键步骤应适当添加截图、流程图等图片元素，使文章更直观，注意图片中的敏感信息（如 IP）记得进行模糊处理。
3. 文中引用其他文章时应尽可能使用程序的官方文档、权威文档 (如 MDN/W3C/IETF/Web.Dev 等)、或其他优质的 原创文章，应避免引用 CSDN/阿里(腾讯)云开发社区 等 臭名昭著的内容农场。
4. 文中引用其他文章时，请尽可能使用原文链接，并添加 [原文链接] 的注释，这是对原作者的尊重，也是对您自己负责。
5. 文章应包含清晰的标题、小标题和内容结构，每个小标题长度应不超过 20 个字。
6. 应该使用 Prettier 格式化 Markdown 代码，Prettier 使用教程请参见下文 推荐写作环境 章节。

#文章大体结构

每篇文章的 最顶部 需要包含以下 Frontmatter 信息：

---
date: 2025-04-12 15:00 +8 # 首次发布时间，格式为 `YYYY-MM-DD HH:MM +8`
updated: "2025-04-12 15:00 +8" # 最后一次内容更新时间，格式同上，可选
version: v0.0.1 # 文章版本号 (建议从 v0.0.1 开始，后续更新投稿时递增)
description: "这里是文章的简要概述，建议在 50~120 字范围内，用于文章预览。"
category: web-services # 分类 id，可选值见下文
sidebarTitle: 安装 Nginx # 侧边栏短标题，建议 16 字以内
cardIcon: Server # 可选，卡片图标名，可选值见下文
cardDescription: "在 VPS.Town 服务器上安装并配置 Nginx。" # 可选，卡片上的一句话简介
author: 您的昵称 # 投稿作者署名
banner: /assets/images/how-to-install-nginx/banner.png # 封面图，站内路径，建议尺寸为 1200x630px
keywords:
  - 关键词 1
  - 关键词 2
  - 关键词 3 # 关键词建议为 3~5 个，用于文章分类
---

# 文章标题

:::details 📖 本文目录

import { Toc } from "@theme";

<Toc />

:::

## 正文第一个小标题

...所有正文...

各字段的含义如下：

教程的 category 可选值：getting-started、cloud-drive、object-storage、virtualization、web-services、installing、code-version-control、download-media、network-diagnostics、system-security、automation-scripts。

cardIcon 可选值：Archive、BookOpen、CircleHelp、Clock、Cloud、Database、Download、FileText、Film、Gift、GitBranch、GitFork、Globe、HardDrive、Image、Lock、Megaphone、Network、Radio、RefreshCcw、Rss、Scale、Server、Shield、Users、Wrench。

其中 author 与 keywords 是投稿审核的要求，站点构建本身不强制；已有的官方文章可以不写作者。

banner 中的 <slug> 为文章的英文文件名 (不含 .mdx 后缀)。投稿时仍把封面图放在压缩包的 images/banner.png，发布时我们会将图片放到对应的站内路径。

页面标题取自正文中的一级标题 (# 文章标题)，无需在 Frontmatter 中重复填写。侧边栏、教程卡片以及文末的上一篇/下一篇都会根据上述字段自动生成，您不需要修改任何 _meta.json 或配置文件。

#3. 投稿方式

您可以通过以下方式提交您的投稿：

• 使用 Telegram Bot 投稿

  • 点击 Telegram Bot 投稿 按钮，添加机器人。
  • 按照以下格式发送投稿内容：
    1. 您的昵称 (将写进文章开头的作者署名)
    2. 您的 VPS.Town 账号邮箱 (用于发放奖励)
    3. 您除了 TG 以外的联系方式 (如 QQ / 微信 / 邮箱等)
    4. zip 压缩包 (压缩包结构可参考下文)

#压缩包结构

仅供参考：

.
├── images/
│   ├── banner.png # 文章封面图片，可选，建议尺寸为 1200x630px
│   ├── image-1.png
│   ├── image-2.png
│   └── image-3.png
└── how-to-install-nginx.mdx # 文章英文路径，注意后缀使用 .mdx

#4. 审核与发布

投稿提交后，VPS.Town 团队将根据 VPS.Town 社区文章投稿及奖励规则 中的审核标准进行内容审核，审核时间一般为 3-7 个工作日。

审核通过后：

• 如果是 Telegram Bot 方式，我们会自动发布您的文章。
• 您的文章将被发布到 VPS.Town 文档中心等渠道。
• 我们会根据文章质量评估并与您确认奖励方案。

如果审核未通过，团队会给出具体的修改建议，您可以根据建议进行修改后重新提交。

#推荐写作环境

#编辑器

• Visual Studio Code (推荐)
• JetBrains Webstorm

#插件

VSCode 推荐使用以下插件：

• MDX (MDX 语法高亮)
• Prettier (格式化)
• MPE (Markdown Preview Enhanced) (预览使用)
• Markdown Mermaid (Mermaid 扩展)

Webstorm 可自行查找对应插件安装。

#写作规范

#Markdown 基本语法

请熟练使用标准的 Markdown 语法：

#标题

# 一级标题

## 二级标题

### 三级标题

#文本格式

**粗体文本**
_斜体文本_
~~删除线文本~~

#列表

- 无序列表项 1
- 无序列表项 2
  - 嵌套列表项

1. 有序列表项 1
2. 有序列表项 2

#链接和图片

[链接文本](https://example.com)
![图片描述](图片链接)

#代码块

```bash
# 这是一个 bash 代码块
echo "Hello World"
```

#高级语法与组件 (MDX)

VPS.Town 文档中心基于 Rspress，支持 MDX，允许您在 Markdown 中嵌入 React 组件和更丰富的语法。

#Mermaid 流程图与图表

```mermaid
flowchart TD
    A[开始] --> B{判断条件}
    B -->|条件成立| C[执行操作1]
    B -->|条件不成立| D[执行操作2]
    C --> E[结束]
    D --> E
```

• 渲染效果

#提示容器 (Admonitions)

用于强调信息，非常实用。

:::note 简单提示
这是灰色的简单提示信息。
:::

:::info 提示
这是一般的提示信息。
:::

:::tip 小贴士
这是一个包含建议或技巧的提示。
:::

:::warning 警告
请注意这个潜在的问题或重要提醒。
:::

:::danger 危险
这个操作有风险，请谨慎执行。
:::

:::details 点击展开查看详情
这里是默认折叠的内容，点击标题可以展开。
:::

• 渲染效果

更多类型和用法请参考 Rspress 文档。

#表格

| 列 1   | 列 2   | 列 3   |
| ------ | ------ | ------ |
| 内容 1 | 内容 2 | 内容 3 |
| 内容 4 | 内容 5 | 内容 6 |

#图片嵌入

![图片描述](./images/image-01.png)

投稿时推荐使用相对路径，请勿使用图床、绝对路径等服务。

#内容建议与范例

#1. 图文并茂

建议在文章中适当添加截图、流程图等图片元素，使文章更加直观易懂。添加图片时，请注意：

• 图片应清晰可辨，尺寸适中、一篇文章内应尽量使用同一尺寸/宽度的图片
• 关键操作步骤最好配有截图 + 文字说明
• 敏感信息（如 IP 地址、密码等）应进行模糊处理

#2. 可操作性

• 提供完整的操作步骤，避免跳跃性的说明
• 对关键步骤进行详细解释
• 提供实际的使用案例或场景
• 可能的话，提供多种实现方式的比较

#3. 准确性

• 确保命令、代码片段经过测试，能够正常运行
• 注明适用的系统版本、软件版本等环境信息，并需要特别标明使用了 VPS.Town 的哪些产品
• 可以链接到 VPS.Town 的文档中心、产品页面等，但投稿中请勿携带 aff 链接，感谢支持

#4. 优秀范例

您可以参考以下已发布的社区贡献文章，了解我们期望的格式和质量：

• 如何在 VPS.Town 服务器上安装飞牛 OS
• 如何在 VPS.Town 服务器上安装 qBittorrent + Alist
• 如何在 VPS.Town 服务器实例上安装 Cloudreve

#联系我们

如果您对投稿有任何疑问，欢迎通过以下方式联系我们：

• 社群：参见 VPS.Town 官方社群
• 投稿 Bot：Telegram Bot 投稿

期待您为 VPS.Town 文档中心贡献您的知识和经验！