用了一周 markdown,分享一下感想。

2018-08-23 16:59:39 +08:00
 humansjl

一直觉得 markdown 的预览格式挺清爽的,本身写文档的时候也没有图片需求,所以尝试用 markdown 写了一份 MTP 文档,把精力集中在内容上,不用纠结排版。不考虑编辑器因素,因为用的都是标准语法,但最终还是放弃了,回到 Word。

主要原因分享出来给想学习 md 的 v 友一些参考:

  1. 表格不支持合并单元格,得用 html 的方式去实现,花的时间更久。以前用过 wiki 挺方便的,没想到 md 居然不支持;
  2. 还是表格,没有找到很好的方式实现 无表头 的功能,还是用 html 代替了;
  3. 代码块,这个其实是最吸引我尝试 md 的地方,但有时 Word 里的一段代码可能包含了 文件操作 /配置修改 /输出样例 等等混在一起的内容,使用 md 代码块时反而不知道用哪个格式,默认的代码块模式看混合代码也没体现出应有的优势;
  4. H1 H2 不支持自动编号(或者说我没找到~~~);
  5. 表格内不支持编号。

以上 5 点,MTP 文档已经写不下去了,放弃。

编辑器用的是 VSCode 和 Typora,编辑的话确实 Typora 方便,预览效果更喜欢 VSCode。

9397 次点击
所在节点    Markdown
27 条回复
araraloren
2018-08-23 17:04:17 +08:00
试试 AsciiDoc ??
表格都是标准内的,更强大。。。
humansjl
2018-08-23 17:09:49 +08:00
@araraloren 谢谢推荐,这次 MTP 完了再试试。本意就是想把精力放在内容上,Word 确实能满足要求,但花在调整格式上的时间实在太长了。也不是说要文档多好看,努力做到其他人有需要时,看文档也能舒舒服服。
GeruzoniAnsasu
2018-08-23 17:12:30 +08:00
markdown 就是写博客那种轻量级格式简单的文章用的

如果你需要复杂的排版,还有代码和公式

你应该寻求 latex
tanglangshan
2018-08-23 17:18:01 +08:00
我的需求,富文本编辑器已经足够了
fuchaofather
2018-08-23 17:21:12 +08:00
Typora 使用 VUE 主题, 挺好看的.
![]( )
loryyang
2018-08-23 17:23:20 +08:00
markdown 写表格确实不行,如果有这个需求,不建议用 markdown
至于 h1、h2 自动编号,我也一直很好奇,为什么没有。这个功能需求还是挺多的吧
humansjl
2018-08-23 17:25:10 +08:00
@fuchaofather 确实不错。
humansjl
2018-08-23 17:27:55 +08:00
@loryyang 习惯了用 Word 为标题自动添加编号,然后左边视图显示导航窗格,1234 编号层级一目了然,然而 md 没有。。。
zhanwh9
2018-08-23 17:46:04 +08:00
@fuchaofather 同喜欢 VUE
omph
2018-08-23 17:51:30 +08:00
@fuchaofather 主题求分享
@humansjl md 本来就是很轻量的格式,如果有特殊要求,开源 md 软件不要太多,可以自己改
wqyyy
2018-08-23 18:06:14 +08:00
能内嵌 HTML 就解决很大问题了
slkass
2018-08-23 18:10:12 +08:00
dm 用得很爽
JCZ2MkKb5S8ZX9pq
2018-08-23 19:44:32 +08:00
@humansjl sublimetext 有一个 package 是给 md 加目录的,不过视图还是没 word 大纲那么友好。可以考虑自己写一个 md 转 html 的。
humansjl
2018-08-23 20:04:33 +08:00
@JCZ2MkKb5S8ZX9pq 难度太高,放弃-.-!! 不过看到这篇文章 https://access.redhat.com/help/markdown,人家大厂反正用 md 完成了知识库的工作,我觉得可以参考参考他们的写作风格。
JohnChiu
2018-08-23 20:08:21 +08:00
md 确实只适合简单文档的编写,所以都是 readme 和博客用这个
MonkeyCoder
2018-08-23 20:58:59 +08:00
@omph 官网第一个就是
idamien
2018-08-23 21:01:03 +08:00
asciidoc ?
MonoLogueChi
2018-08-23 21:03:38 +08:00
这些都要看你用什么渲染成网页,你可以自定义一些 markdowm 语法,然后用自己的方式去渲染
saulshao
2018-08-23 21:44:44 +08:00
我大概用了 2 年的 Markdown。用来写设计文档。我不太喜欢用图,因此就是一大堆文字描述。
程序员给我的反馈是一开始难以理解,但是时间长了,尤其是需要变更的时候修改方便。
lfzyx
2018-08-23 21:48:17 +08:00
sphinx 了解一下?

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

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

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

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

© 2021 V2EX