如何撰写博客文章
如果您有撰写博客文章的想法,请遵循以下步骤来提出建议并有可能将其发表!
-
提议您的文章
在花时间撰写文章之前,请确认我们能够发表。我们正在寻找与 Express 相关的特定主题,因此我们希望预先批准所有文章。目前,这意味着我们不接受任何未经请求的文章。要提议博客文章,请打开一个议题,标题为
博客文章提议:<您的想法>
。 -
Fork 仓库
如果 Express 技术委员会(TC)接受您的提案,请通过 Fork expressjs.com 仓库并将其克隆到本地机器来开始撰写您的文章。一旦您打开 Pull Request,您将能够在 GitHub 上预览您的文章。请参阅下面的第六步。
可选:要在本地运行站点并在打开 Pull Request 前预览您的文章,请参阅 README 中的设置说明。
-
创建新文件
在
_posts
目录下创建一个新文件,命名格式如下:YYYY-MM-DD-title.md
。 -
添加所需的前置元数据
复制以下前置元数据,包括虚线,并将其粘贴到您刚创建的文件顶部。根据需要替换占位符值。
--- title: <your-title> sub_title: <your-optional-sub-title> description: <description-of-your-post> tags: <white-space-separated-topics> authors: - name: <your-name> github: <github-username> ---
作者的
github
属性是可选的。仅包含您的用户名(而不是您的完整个人资料 URL)将确保您的博客文章链接到它。 -
添加您的内容
最后,在前置元数据下方开始撰写您的内容。使用标准 Markdown 格式。
-
打开 Pull Request (PR)
一旦您打开 Pull Request,您将能够预览您的结果:页面上会有一个名为
expressjscom-preview 部署预览已就绪!
的部分。点击链接以查看从您的 Fork/分支渲染的站点。您可以在多次提交中使用此功能,通过创建
草稿
Pull Request 来完善您的文章。一旦准备好审查,将其切换为正式的 Pull Request。