Markdown是一种网络书写语言,其目标是实现易读易写,且兼容HTML语言。Markdown的流行得益于Github和Stackoverflow,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。
分享到:
相关推荐
用 Markdown 撰写文档,javascript 解析成HTML的编辑器,针对微信公众号排版使用
markdown 基础文档
markdown开发接口文档模板, 最近公司开发项目需要前后端分离,这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写...
一种能很有效的嵌入html,css,程序代码块的文档编辑器,git上传的文档都是用这个的
本资源提供了一个简单方法,用于生成华丽的markdown文档侧边栏目录。本资源包含一个模板文档,没有任何程序代码,简单易用。本模板是对开源项目 i5ting-i5ting_ztree_toc-0.3.0-11 的精简,主要是针对Windows下无法...
Markdown语法的中文文档,文档本身使用Markdown编写。
这是一个markdown到文档的生成工具
数据库文档生成器,根据数据库表DDL生成markdown和word文档.zip
Markdown 语法文档 整理与修缮
docker进阶篇markdown文档
markdown4j 是一个开源的 Java 的 Markdown 处理器,具备可扩展性。基于 Txtmark 的改进版本。 特性: 跨平台 轻量级,无需依赖第三方库 实现了 John Gruber's incredible Markdown text-to-html 转换工具 实现...
简单来说,markdown 其实是一种轻量级的标记语言,都是自己整理的易学易懂
快速搭建自己的文档系统, 全部用Markdown来编写文档
发布后 从Postman生成markdown API文档。安装pip install postdown用法从邮递员导出JSON 从Postman导出您的收藏集... 运行postdown生成markdown文档: postdown xxx.json xxx.md然后,您将获得降价格式的API文档。
借鉴了网上各位大牛分享的md转html,有前端小伙伴的帮忙,共同研发出了一个小工具,将markdown文档转换成html,左右结构,左侧目录,右侧文档 请先阅读readme
文档导出工具类,能将markdown格式的内容,转为office word,PDF,HTML等等...不使用markdown格式的内容,直接调用MD2File的api,生成word,pdf等文档也是可以的。 另外,还可以将MD2File作为markdown转HTML的工具类。
Markdown 是一种轻量级的文本标记语言,用于创建清晰、简洁、易于阅读和易于维护的文档。它允许用户通过简单的标记语法,将文本格式化为各种样式,例如标题、列表、链接、图像等等。 以下是 Markdown 语法学习文档的...
markdown在线api接口编辑,像写代码一样的编写接口文档.zip,showdoc是一个非常适合it团队在线共享文档的工具
基于Echo官方文档主题改造