使用Markdown写文档

转载于:http://blog.csdn.net/xiahouzuoxin/article/details/19752603

Markdown是一种网络书写语言,其目标是实现易读易写,且兼容HTML语言。Markdown的流行得益于GithubStackoverflow,Stackoverflow的代码块以及Github上的README.md文件格式都是通过Markdown表现的。从这里您可以很直观的看到Markdown的效果:https://github.com/adam-p/markdown-here

使用Markdown可以书写自由书籍,关于此,您可以参看文章用Markdown来写自由书籍-开源技术的方案开源书和开源技术-Markdown篇一文也介绍了一些Markdown与开源书和开源技术之间的渊源。已经有一些开源书籍使用Markdown书写了,亚嵌教育的开源书籍源码开放学ARM、蒋鑫老师的GotGithub一书,这些开源书籍都给学习者提供很大帮助。Markdown书写已经是一种开源精神体现。好了,既然Markdown与自由书写这么默契,我们怎么用Markdown来写自己的README.md,自己的博客甚至自己的开源书籍呢?

这里有一份Markdown的语法,http://wowubuntu.com/markdown/,从这里(https://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/syntax.md)看可能更直观。Markdown语法是如此简单,以至于还不到1000行就描述完了。初学者您可以参考献给写作者的Markdown新手指南。Github的Markdown语法大部分都与传统Markdown语法一样,这您可以看看markdown-basics,但也有些扩展,扩展内容在文档GitHub
Flavored Markdown
中。

在使用Markdown过程中,您也许还需要一个时时显示Markdown文档预览的工具,这方面的工具有很多,这里推荐几个在线的Markdown文档编辑器:

1. Dillinger:       http://dillinger.io/

2. StackEdit:    https://stackedit.io/

3. 印象笔记:     http://maxiang.info/

免费Markdown写作工具简评”一文提供了有关于Markdown文档编辑器的更多信息。

谷歌浏览器貌似也有Markdown的预览插件(https://github.com/volca/markdown-preview),这样您就可以用记事本编辑,用浏览器预览了。

印象笔记也有Chrome的扩展,可在商店搜素“马克飞象”。

我们说Markdown是为了书写自由电子书,那么Markdown如何生成pdf或html格式的文档呢?我们可以借助Markdown文档编辑器的功能,StackEdit就能胜任,使用StackEdit左上角的菜单,save
as..就可以做到。

还有一款集编辑与Markdown预览于一身的不错工具Everedit,国产的哦..

最后,你可以在Github上找到这篇文章的Markdown版本:https://github.com/xiahouzuoxin/notes/blob/master/README.md

时间: 2024-10-12 15:55:34

使用Markdown写文档的相关文章

从 Word 到 Docbook, 最后用 Pandoc, 让程序员爱上写文档

写文档一直是程序员非常讨厌的工作, 甚至和改需求一样令人厌烦. 在程序员眼里比写程序还难, 即便强制执行下来文档质量也很难让人满意. 相信大多数公司写文档都是用 Word, 笔者也是用了 Word 写了好几个项目的文档. 架构, 设计, 运维等好几份, 呵呵, 即便是写的再好, 交给客户也基本是不看的. 一个文档是项目组内好几个成员编写的, 大家各写各的模块, 各自的实现, 然后一起合并, 合并时修改字体, 字号, 目录等, 第一次合并还好, 再升级几个版本后, 大家改了哪里, 没改哪里, 根本

写文档的一些感触

软工写文档也有一个多星期了,还没有写完,感觉太慢了~ 对于软工文档,最大的感觉就是不知道该怎么写.问过一个师哥,师哥说这次写主要是为了让我们先了解一下写文档,现在让我们真正写那肯定是写不好的.后面还会有项目来练习的. 真正优秀的程序员应该不单是编程高手,同时也应该是写文档的高手.大多数程序员是不喜欢写文档的.文档种类多,要求多.需求的改变和代码的改变都会让文档如同一张过时的废纸一样.很多程序员不写文档照样能编出程序来,文档的好处更多的体现在公司.用户和后续程序员身上.这样即使程序员走了,只要有文

从程序员到项目经理(29):怎样写文档【转载】

在软件项目中,文档既是一项的重要成果,也是项目管 理的有力工具.通过文档,可以稳定.明确的传达信息,实现项目内的有效沟通.所以写文档对项目经理来说,是一项必备的技能. 然而很多项目经理害怕写文档,似乎这是一个很麻烦. 很困难的工作.其实会不会写文档,只是一种外在的表现,通过一个人写文档的情况,可以看出他对工作的理解程度,发现潜在的问题和风险.一个合格的项目经理,不但不会怕写文档, 而且会觉得这是一件简单.很自然的情,就像一个人吃饭.喝水一样,何难之有? (本人拙作<程序员第二步 -从程序员到项目

写文档能力培养

从本人的经历来看,大部分做项目的都写不好文档,但在实际工作中却又需要写大量的文档 比如写招标文书.投标文件.项目验收报告等等,除了写文档以外,还需要做PPT,给专家或客户进行详细讲解 说句不好听的话,项目的成败往往并不取决与你的软件技术有多高,有时候可能就是因为你的投标文件写的好.PPT做的漂亮就拿到了项目 1.要有封面.目录,不应该一上来就是正文,这样显得不正式 2.各章节的编号要统一,对项目报告来说一般来说使用多级标题,类似1.1.1.1.1.1这种标题,有层次感,其中标题字体根据标题的层级

Java中按行写文档的方法

原文引用https://www.dazhuanlan.com/2019/08/25/5d622ab9a21fa/ 这篇文章总结了使用相关类写文档的操作 1. FileOutputStream 12345678910 public static void writeFile1() throws IOException { File fout = new File("out.txt"); FileOutputStream fos = new FileOutputStream(fout);

Java POI Word 写文档

package apache.poi; import java.io.ByteArrayInputStream;import java.io.ByteArrayOutputStream;import java.io.File;import java.io.FileInputStream;import java.io.FileOutputStream;import java.io.IOException;import java.io.OutputStream;import java.util.Ha

你用什么写文档?

confluence:公司行政制度文档,开发流程文档 方法api文档 组件参数文档 组件ui文档 原文地址:https://www.cnblogs.com/camille666/p/write_doc_by_tools.html

php markdown 接口文档生成工具

2017年9月18日 19:20:22 星期一 效果: 码云: https://gitee.com/myDcool/PHP-Markdown.git 说明: 简单的MarkdownApi管理工具:左侧目录树: dtree.jsMarkdown转html: segmentfault社区开发的PHP工具遍历md源文件夹: 自己写的利用后根序遍历算法读取文件夹PHP工具 使用说明: 1. 需要安装 PHP 最好是7环境 2. 将md文件放入src目录里, 按照自己的项目命名文件和文件夹(这些名字就是最

锋神教我数据库,吴大哥教我写文档——其一

昨晚锋神说:实体集就是脱离了其他集可以独自存在的,联系集就是与其他集产生联系才有存在意义的 (一下摘自mactalk迟建强微信公众平台) 传统的软件产品开发一般是这样的: 1.确定产品定位和需求,确定首次迭代的范围.2.制作界面原型.3.技术选型,然后根据技术选型为每个开发者搭建开发环境和技术栈,例如 Java 环境.Python 环境.Ruby 环境.数据库.中间件等等.4.构建基础技术框架和服务,包括日志.存储.消息.缓存.搜索.数据源.集群扩展等等.5.模拟用户容量,构建测试环境.6.开始