🌐 Nodejs.cn

如何写一篇博客文章

Express Technical Committee

如果你有博客文章的想法，请按照以下步骤提出，并有可能发表它！

🌐 If you have an idea for a blog post, follow these steps to propose it and potentially get it published!

  1. 提出你的帖子

    在花时间撰写文章之前，请确认我们能够发布它。我们正在寻找与 Express 相关的主题，因此我们希望预先审批所有文章。目前，这意味着我们不接受任何未经请求的文章。要提议博客文章，请创建一个标题为 Blog post proposal: <your idea> 的问题。

  2. 分叉仓库

    如果 Express TC 接受你的提议，请通过分叉 expressjs.com 仓库并将其克隆到你的本地机器上来开始撰写你的帖子。一旦你打开了拉取请求，你就可以在 GitHub 上预览你的帖子。见下方的第六步。

可选：要在本地运行网站并在提交 PR 之前预览你的帖子，请参阅 自述文件中的安装说明。

  1. 创建新文件

    在 src/content/blog 目录中创建一个新文件，文件名按照以下格式命名：YYYY-MM-DD-title.md。除非在前置内容中设置了 date 字段（见下文），否则日期前缀将用作发布日期。

  2. 添加所需的前言部分

    复制以下前言内容，包括虚线，并将其粘贴到你刚创建的文件顶部。根据需要替换占位符值。

    ---
    title: <your-title>
    description: <description-of-your-post>
    date: YYYY-MM-DD
    tags: ['tag1', 'tag2']
    authors:
      - name: <your-name>
        github: <github-username>
    cover: <optional-cover-image-path>
    ---

    作者的 github 属性是可选的。只填写你的用户名（而不是完整的个人资料 URL）将确保你的博客文章能够链接到它。

    date 属性是可选的。设置后，它决定文章的发布日期（用于排序、显示和信息源）；否则，使用文件名中的 YYYY-MM-DD 前缀。

    cover 属性是可选的。如果省略，系统将根据文章标题自动生成 Open Graph 图片。如果你想使用自定义封面图片，请将其放在 public 目录中并引用其路径（例如 /images/my-cover.jpg）。

  3. 添加你的内容

    最后，在前言部分下面开始撰写你的内容。使用标准的 Markdown 格式。

    使用组件（MDX）

    如果你需要在文章中使用交互式组件，例如警报、提示或其他用户界面元素，请将你的文件从 .md 重命名为 .mdx。MDX 允许你直接在你的 Markdown 中导入和使用 Astro 组件。

    例如，要添加一个提醒：

    ---
    title: My blog post
    description: A post with alerts
    tags: ['security']
    authors:
      - name: John Doe
        github: johndoe
    ---
    

    import Alert from '@components/primitives/Alert/Alert.astro';
    

    This is regular markdown content.
    

    <Alert type="warning">
      We strongly recommend upgrading to the latest version as soon as possible.
    </Alert>
    

    <Alert type="info">

This feature is available starting from Express 5.0. 

<Alert type="alert">
  This is a breaking change. Please review the migration guide before upgrading.
</Alert>
```


可用的警报类型有 `info`、`warning` 和 `alert`。

  1. 打开一个拉取请求（PR）

    一旦你打开一个 PR，你将能够预览你的结果：页面上会有一个名为 Deploy Preview for expressjscom-preview ready! 的部分，点击链接即可查看从你的分叉/分支渲染的网站。

    你可以在多个提交中使用此功能，通过创建一个 draft 拉取请求来完善你的帖子。一旦准备好进行审查，就将其切换为正式的 PR。

来自《快报》的更多内容