貌似微软整个公司的文档现在都在用 Markdown 格式?

2019-04-23 06:29:27 +08:00
 Livid
每一个像这样的展示页面:

https://docs.microsoft.com/en-us/azure/cosmos-db/

背后都可以找到在 GitHub 上的 Markdown 源代码:

https://github.com/MicrosoftDocs/azure-docs/tree/master/articles/cosmos-db
24204 次点击
所在节点    Markdown
31 条回复
Livid
2019-04-23 06:31:31 +08:00
看起来是 2016 年时候的一个巨大的改变:

https://docs.microsoft.com/en-us/teamblog/introducing-docs-microsoft-com
Livid
2019-04-23 06:42:20 +08:00
关于这个新文档系统的文档:

https://docs.microsoft.com/en-us/contribute/
Livid
2019-04-23 06:57:14 +08:00
基础语法部分基于 CommonMark 标准,然后扩展语法部分及渲染是这个:

https://dotnet.github.io/docfx/
formulahendry
2019-04-23 07:27:28 +08:00
曾经的负责 docs 的开发部门做过。

应该说,现在大部分手写的文档用的是 Markdown,但不全是。

对于从代码自动生成的文档,比如 https://docs.microsoft.com/en-us/cli/azure/reference-index?view=azure-cli-latest ,一般是 Markdown 或者 YAML: https://github.com/MicrosoftDocs/azure-docs-cli/tree/master/2017-03-09-profile/docs-ref-autogen
Livid
2019-04-23 07:33:44 +08:00
@formulahendry CommonMark 里没有包括对表格和 code block 的支持实在是个遗憾。
celeron533
2019-04-23 07:39:51 +08:00
我记得 markdown 还是支持内嵌 HTML 的
WildCat
2019-04-23 07:48:32 +08:00
@Livid 不全是,毕竟是创造 Word 的公司 🌚
airyland
2019-04-23 07:53:08 +08:00
腾讯云和阿里云的文档目测也都在 Github 上开源维护了。
hwdef
2019-04-23 08:11:33 +08:00
这么看的话,word 和 onenote 到现在都不支持 markdown 还真是怪异,对微软来说加个 markdown 又不会影响什么,也不难。
Livid
2019-04-23 08:12:28 +08:00
@hwdef 喜欢 Markdown 的人最终会用 VS Code 吧。
Ley
2019-04-23 08:14:55 +08:00
Azure 这一块 Rest API 文档是 swagger。还一些是 MD,DocFX 转的。然后新的好像开始用 Yaml 了。
hwdef
2019-04-23 08:20:38 +08:00
@Livid 说的也对,用 markdown 的大部分是程序员,office 的产品定位可能不是面向程序员的,
FancyKing
2019-04-23 09:10:42 +08:00
我还是希望,OneNote 能加入 markdown (最起码代码能好看点
passerbytiny
2019-04-23 09:13:35 +08:00
完全无纸化,非打印格式,面向开发人员,并且很少协同编辑,这种情况下 Word 对 Markdown 几乎没有优势,而 Word 与 Git 犯冲的劣势就很突出了。

关键是微软啥时候开放他的 Markdown 引擎。
matolv
2019-04-23 09:50:19 +08:00
Markdown 有 VScode。word 不是给程序员用的,而是给写文章,写书,写论文,写一切非 IT 第二产业文档用的。
Flobit
2019-04-23 09:54:51 +08:00
感觉以后 markdown 会很普及,因为这个很方便,而且给人看也很一目了然,但是感觉用 markdown 写一些很正规的文件还是不行的。已经在叫女朋友学习 markdown 了
GTim
2019-04-23 09:58:17 +08:00
@Livid 我是特例,用了几回 VS Code,最后都换回 Sublime Text 3 了。

1. 启动速度不能忍
2. 搜索在左侧小栏目不能忍
3. 左侧文件列表动不动就被替换不能忍
Kei
2019-04-23 09:59:34 +08:00
然而依旧没有一个成熟的 TypeScript 的 Comment Markdown 生成工具(
qyc0129
2019-04-23 10:21:37 +08:00
看来大家追求启动速度是一致的
CallMeReznov
2019-04-23 10:31:42 +08:00
那他娘的 ONENOTE 为什么还不支持 MD 呢!

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/557733

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX