我如何撰写在线文章
直奔主题
我喜欢写作,写作时我更喜欢用 Markdown 写。最近有人问我的写作流程是怎样的,所以我决定在这篇短文里记录下来。这就是我的写作流程,你不必觉得必须照搬。希望这篇文章能帮到你。
我的写作过程
所有这些都假设我有一个想法,并且我知道自己在写什么。这本身就是一个完全不同的话题,这里就不赘述了。如果你想了解我是如何写作的,这里就是你应该去的地方。
我的目标
我写作的主要目标有:
- 稳定的工具:我写的内容必须是稳定的(我不想重写它!)
- 保存:我想保存我的文章,这样我就可以迭代、参考并始终拥有它。
- 校对:我想检查我的文章的拼写和语法。
- Markdown:我更喜欢用 Markdown 书写
- 离线:必须离线工作
我的工作流程
我的工作流程很短,而且达到了我的主要目标。那就让我们直接开始吧。
-1-VS代码
我使用VS Code撰写文章。它对 Markdown 的支持非常出色,而且非常稳定,这满足了我的两个目标。此外,我整天都用它来编写代码,所以不需要切换到其他工具。
以下是我使用的 VS Code 扩展:
- Markdown Lint
- Markdown 预览
- 拼写正确
- Peacock - 我使用颜色代码编写我的 vs code 编辑器来撰写文章
- 2 - 校对
我目前使用 Spell Right(见上面的链接)检查 Markdown 中的拼写。然后,我将内容复制粘贴到 Grammarly 的本地文档中进行语法检查。您可以使用任何语法检查工具,包括 Microsoft Word。
我觉得这是一个很好的举措,因为拼写检查只能捕捉到故事的一部分。语法检查有助于避免句子混乱。
- 3 - 推送到私人 GitHub 仓库
保存我的内容并确保不会丢失(我的两个目标)通过创建一个 GitHub 仓库来强化。我更喜欢将其设置为私密,因为里面存放了我大量的写作内容。我还以一种对我来说合理的方式来组织我的仓库。这样我就可以快速找到我的文章,进行修改、迭代,并继续前进。
VS Code 与 GitHub 集成良好,我每天都用它来进行源代码管理。我感觉用熟悉的工具写文章、提交、推送和推进都很舒服。
这是我在 dev.to 中的元数据示例:
---
title: How I Write Online Articles
published: true
description: How you can write online articles
tags: devrel, vscode, markdown, discuss
cover_image: https://thepracticaldev.s3.amazonaws.com/i/n0ecqvxjrzh9qy6ekfgy.png
canonical_url: https://johnpapa.net/how-i-write-online-articles/
---
- 4 - 复制并粘贴到目标网站
我的文章发布目标平台可以是 Ghost(我的博客托管平台)、Medium、dev.to 或任何其他平台。遗憾的是,由于这些平台各不相同,有些平台支持各种功能,而且很少有 API,所以我目前只能复制粘贴。复制粘贴只需要几分钟,所以没什么大不了的。
一旦我粘贴到目标平台,我通常会发现一些看起来有点别扭的东西。我会在目标平台上进行调整,在预览中测试(而不是发布),然后重复这个过程,直到完美为止。
然后我将更改复制回本地 VS Code 编辑器,提交并推送。
- 5 - 在我的博客上发布,然后发布到 dev.to
我首先将内容发布到我的博客,因为这是我的博客,我喜欢为所有内容找到一个归宿。然后,我复制博客文章的规范 URL,并通过设置 将其复制到标题中的 dev.to 目标canonical_url
。之后,我会将同一篇文章发布到 dev.to。
封面图片或 SketchNotes
我喜欢在文章中添加一些视觉元素。我发现文章中的视觉元素能帮助我理解概念。而且,这很有趣!有很多方法可以获得免版税图片。Pexels就是其中之一。
我经常想要一个非常具体的图像,画出来要容易得多。这时我就用到我的速写笔记了。这篇文章顶部的速写笔记就是我用来构思文章的。
我将在以后的文章中分享更多有关如何以及为何使用 SketchNotes 的信息。
未来的想法
我希望所有写作平台都能拥有一个开放的 API,尤其是 dev.to。想象一下,你用你最喜欢的工具(比如 VS Code)在本地写作,然后按下一个命令,就能把文章发布到 dev.to!我目前正在讨论如何编写一个扩展程序来发布到 dev.to。这个扩展程序需要目标平台的 API 以及一些我可以编写的酷炫功能(比如使用 Liquid 嵌入的 Gist 预览)。不过……嘿……这会很有趣,也很实用。
dev.to 的优秀团队正在考虑一个 API。我想,这只是他们正在优先考虑的众多优秀创意中的一个功能。
显示阅读时间
我喜欢查看 Markdown 的阅读时长预估。这有助于我了解阅读时长是否符合我的预期(无论长度是长是短)。这是我写的一篇关于这个新扩展的文章,以及一个安装链接。


在 VS Code 中展示阅读 Markdown 的时间
John Papa 代表 Microsoft Azure ・ 2019 年 4 月 8 日
你做什么工作?
我分享了我的写作过程。我很想听听你的!你的写作有什么不同吗?你喜欢它什么?你希望改变什么?
文章来源:https://dev.to/azure/how-i-write-online-articles-1lfb