论坛首页 综合技术论坛

用Markdown做文档的问题

浏览 3880 次
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
作者 正文
   发表时间:2013-12-23  

一直有想一种语言能够解决文档编写问题。

 

一般文档编写的需求:

  • 普通文档
  • README等代码附带文档
  • PPT
  • 文章
  • 学术相关:论文,书籍

上述文档,因其需要使用到的领域不同,没有一个工具可以兼顾语法简明性、编写简单、纯文本可读、表意丰富等特点。原本希望找到一个通用的工具,看样子是不可能了。这方面寻求高手指导。

 

目前的组合解决方案如下:

  • 普通文档: Markdown
  • README等代码附带文档: Markdown
  • PPT: Markdown+pandoc+latex
  • 文章: Markdown/latex
  • 学术相关:论文,书籍: latex
   发表时间:2013-12-25  
试试看这个呢?
http://sphinx-doc.org/contents.html

优点
我以前也老用Markdown写文档,但是发现最后散落得到处都是,没有一个统一的整理。
使用基于reStructruedText的sphinx,至少复数文档的结构化,内容搜索,web化,文本可读,语法简单,语义丰富,多格式输出这些都照顾到了。

缺点:
头疼的是没有一个好的所见即所得的编辑工具,只能写完自己生成看看了。
语法稍微有点怪异符号也是比Markdown稍微欠缺的,不过功能确实强大。

感觉最适合做技术积累,各种语言的API文档,成章节的复数文档整理,多人同时文档编写作业。
单文件的Readme的话,还是Markdown更简单一点。
0 请登录后投票
   发表时间:2013-12-25  
对于PPT处理,该工具有无好的方法?
0 请登录后投票
   发表时间:2013-12-26  
qianjigui 写道
对于PPT处理,该工具有无好的方法?


这个工具可以将源文档转换成多种格式,包括您熟悉的latex,然后有了latex就随便转了。
CHM,HTMl, XML, JSON,TXT, PDF这些常用格式也都支持
0 请登录后投票
论坛首页 综合技术版

跳转论坛:
Global site tag (gtag.js) - Google Analytics