作者都是各自领域经过审查的专家,并撰写他们有经验的主题. 我们所有的内容都经过同行评审,并由同一领域的Toptal专家验证.
风暴法雷尔的头像

风暴法雷尔

Storm是一个有7年以上经验的前端开发者,专注于UI/UX, JavaScript和React.

工作经验

13

分享

如果你是 软件工程师,你可能花了很多时间来改善你的环境,以提高你的工作效率. 你已经有了你最喜欢的IDE. 您已经有了自己喜欢的调试器. 您已经拥有了最喜欢的性能监视工具. 但是用于编写文档、手册和报告的工具呢? 毕竟,写作确实占用了你大量的时间,不是吗? 的确,是时候认真对待你的写作工具了.

让我们记住这一点 你很专业因此,所见即所得编辑器可能是您的最佳选择,也可能不是. 你不一定想要(甚至不喜欢)!)导航菜单,工具栏和色带来格式化您的文本.

那如果, 而不是, 您可以轻松地将所有格式化样式作为简单的内联语法添加到文本中,从而生成完全格式化的文本?

事实上,你可以. 这是 减价 这就是本教程的全部内容.

当多即是少……

文字处理软件的编写是为了满足极其广泛的用户和用例, 像这样, 需要提供各种功能. 但很明显, 只有一小部分功能可能与每个用户相关. 对于大多数用户来说, 谁只是想写一个文档(不需要设计一个营销宣传册或海报), 只是很多人中的一小部分, 许多可用的选项都是相关的.

事实上, 微软在几年前就意识到了这一点,他们将Word的用户界面重新设计为不同的功能组,他们称之为“缎带”. 然而,有趣的是, 大多数用户会告诉你,他们发现新界面比之前的版本更令人困惑,更难以操作.

学习减价

的确,在易用性和生产力方面,有时多则少.

以及《欧博体育app下载》

面对现实吧,你是软件工程师,不是平面设计师. 你只是想写手册,或者技术文档,或者报告,然后完成它. 你会非常满意一些基本的格式化功能,比如标题, 项目符号或编号列表, 和代码块. 对了,还有一些字体格式(粗体,斜体等).)也会有帮助. 就是这样. (天哪,如果你能做到这一点 vi那就太棒了!)

进入减价.

什么是降价?

约翰•格鲁伯 (来自技术大师和互联网活动家的大量贡献 亚伦斯)在2004年创建了减价语言 我们的目标 使人们能够用易于阅读的文字来写作, 易于编写的纯文本格式, 并可选择将其转换为结构有效的XHTML(或HTML)”.

减价被设计成可读的, 而不会让它看起来像被标记或格式化指令(不像用RTF或HTML等标记语言格式化的文本,这些标记语言在原始格式下既难以编写又难以阅读)。.

减价允许您使用易于阅读的方式编写, 易于编写的纯文本格式, 然后可以将其转换为结构有效的HTML. 所以,准确地说, 降价实际上是两件事:

  1. 纯文本格式化语法
  2. 一种将纯文本格式转换为HTML的软件工具(其第一个版本是用Perl编写的).

减价包含了一些简单、相当直观且易于使用的语法约定. 尤其是作为软件工程师的你——你不会因为需要学习和使用这些基本的语法惯例而拖延——减价确实可以是最有效的 最小阻力路径 在你想写的东西和别人写出来之间.

标记语法约定

学习降价:入门

降价很容易学. 超级简单. 你可以在五分钟内学会基本知识,很快就会成为你的第二天性. 而且——就像CSS和CSS预处理器之间的关系一样——你可以随心所欲地少用或多用.

如果你习惯了任何形式的纯文本书写约定, 那么你可能已经熟悉了一些降价惯例, 比如句子开头的数字或破折号来创建一个列表, 在单词周围加上星号以示强调, 等等......。. 因此,例如,如果您想以斜体显示某些内容,只需将其用星号括起来,就像 <代码>*本*> < /代码 (而不是笨拙的HTML语法,如 <代码>this> < /代码).

类似地,您可以通过简单地在行(e .)前添加“#”前缀来指定H1标题.g., <代码>#节标题> < /代码,而不是 <代码>

Section Heading

> < /代码).

学习减价的另一个重要用途, 尤其是对我们软件工程师来说, 是将其用于源代码存储库的文档. 大多数回购包括一个 <代码>自述.md> < /代码 文件(<代码>.md> < /代码 是减价文件的标准扩展名). 例如,Github有自己的“Github风味减价”,它补充道 额外的功能 特别是开发文档. 这当然可以节省用HTML编写文档的时间.

举个简单的例子,假设你想在你的文档中包含以下代码片段:

Initiating Plugins

在你的容器上使用jQuery初始化<代码>pluginName> < /代码,如下所示:

<代码>$(function() {$('#container')).pluginName (); });> < /代码 Using our container’s ID, 我们可以用jQuery方法<代码>初始化<代码>pluginName> < /代码.pluginName ()> < /代码.

下面是在HTML和HTML中如何实现这一点的比较. 减记:

HTML减价

Initiating Plugins

#初始化插件

启动 pluginName 在你的容器上使用jQuery如下所示:

在你的容器上使用jQuery初始化' pluginName ',如下所示:

$(function() {$('#container')).pluginName (); });
$(function() {$('#container')).pluginName (); });`

Using our container's ID, we can initiate pluginName 使用jQuery方法 .pluginName ()

使用我们的容器ID,我们可以用jQuery方法初始化' pluginName '。.pluginName ()”.*

获得进一步的帮助开始, 网上有很多降价教程可以帮助你跟上进度,包括一个 减价的概述 约翰·格鲁伯(减价的创造者)以及一个在线的 减价教程.

降价解析器和工具

在减价中编写完文章后,需要一个应用程序将语法解析为HTML. 有一些很棒的 免费的 包括:

  • StackEdit -基于浏览器的减价编辑器,有一些同步选项与流行的服务,如Google Drive和Dropbox
  • 在线Kramdown编辑器 -另一个基于浏览器的减价编辑器,界面非常简单
  • 谅解备忘录 - the best Mac-based 减价 writer I’ve come across as a geekier option for developers; tons of features and 免费的 (while in beta) [这是我用来写这篇文章的]
  • 减价Pad -伟大的减价编辑器的Windows
  • 文本 - a nice cross-platform (Mac and Windows) editor; exports to multiple formats such as PDF, .doc和ePub

一些主流平台已经在编辑器中采用(或至少允许)减价功能,供希望使用它的用户使用. 与他人, 比如WordPress, Evernote, 和谷歌文档, 原生支持(在撰写本文时)还没有到位, 但是定制解决方案已经被第三方引入. 这些包括:

  • 流行的新博客平台 为了精简在线写作,该公司使用减价作为其内容编辑器.
  • 对于WordPress, Jetpack插件现在正式支持减价,你可以在下面启用 Settings > Discussion 如果你使用插件. 或者你可以使用插件,比如 WP-减价 这将转换你的帖子markdown内容为HTML,并回到markdown当你需要编辑它.
  • 对于印象笔记,一些减价应用程序,如在线编辑器 标示 或者Mac编辑器 笑柄 允许直接导出和发布到笔记. 或者,如果你喜欢直接使用Evernote的web应用程序,你可以使用一个浏览器扩展名为 减记在这里 按一下工具栏按钮,就可以将写入减价的选定笔记转换为格式化的文本.
  • 谷歌文档本身还不支持减价,但是一些编辑器(比如 StackEdit)将直接导出/同步到驱动器.

的缺点

当然,简单也有其局限性. 我已经解释过了, 减价不是为需要高级格式化功能的复杂文字处理任务而编写的. 如果这就是你需要的,减价不是合适的工具.

但是对于需要编写用户手册或 技术文档 或者一份技术报告, 减价在简单性和您需要的功能之间提供了近乎完美的平衡.

也许最大的缺点——尤其是对我们这些热衷变更控制的工程师来说——就是无法做到这一点 工作协作 并跟踪变化(不过,有一个值得注意的例外是 StackEdit 谷歌文档插件. 当然, 用最少的努力, 你可以简单地通过git存储库在减价文档上进行协作,从而获得你通常需要的所有更改跟踪和协作.

结论

对所有人来说,学习减价也是如此? 当然不是. 没有一个工具是这样的.

但如果你是一个软件工程师, 它很可能正是你一直在寻找的写作工具. 所以,如果你还没有尝试过,你真的应该试一试.

就这一主题咨询作者或专家.
预约电话
风暴法雷尔的头像
风暴法雷尔

位于 慕尼黑,巴伐利亚,德国

成员自 2015年2月24日

作者简介

Storm是一个有7年以上经验的前端开发者,专注于UI/UX, JavaScript和React.

Toptal作者都是各自领域经过审查的专家,并撰写他们有经验的主题. 我们所有的内容都经过同行评审,并由同一领域的Toptal专家验证.

工作经验

13

世界级的文章,每周发一次.

订阅意味着同意我们的 隐私政策

世界级的文章,每周发一次.

订阅意味着同意我们的 隐私政策

Toptal开发者

加入总冠军® 社区.