当前位置: 首页 > news >正文

使用Markdown写文档

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

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。

相关文章:

  • 普通pc安装懒人版的mac 10.10系统安装
  • mybatis-generator 基类继承
  • Spring MVC学习总结(5)——SpringMVC项目关于安全的一些配置与实现方式
  • 神奇的Android Studio Template
  • 微信端页面使用-webkit-box和绝对定位时,元素上移的问题
  • mysqldump 数据库备份
  • iOS App 启动页
  • 自己动手写RTP服务器——关于RTP协议
  • [转]ASP.NET 成员资格 Part.1(API)
  • uint8_t / uint16_t / uint32_t /uint64_t 是什么数据类型 - 大总结,看完全明白了
  • Linux用户和权限管理
  • iOS 宏(define)与常量(const)的正确使用
  • linux系统安装python2.7
  • phoenixframework自动化测试平台webUI模块执行js代码示例
  • Spark VS Hadoop:两大大数据分析系统深度解读
  • 2017 年终总结 —— 在路上
  • 2017年终总结、随想
  • DOM的那些事
  • Hexo+码云+git快速搭建免费的静态Blog
  • Vue官网教程学习过程中值得记录的一些事情
  • 前嗅ForeSpider教程:创建模板
  • 设计模式 开闭原则
  • 深入 Nginx 之配置篇
  • 使用API自动生成工具优化前端工作流
  • 文本多行溢出显示...之最后一行不到行尾的解决
  • 怎么把视频里的音乐提取出来
  • Redis4.x新特性 -- 萌萌的MEMORY DOCTOR
  • ​力扣解法汇总946-验证栈序列
  • ​批处理文件中的errorlevel用法
  • # C++之functional库用法整理
  • #鸿蒙生态创新中心#揭幕仪式在深圳湾科技生态园举行
  • #基础#使用Jupyter进行Notebook的转换 .ipynb文件导出为.md文件
  • (动态规划)5. 最长回文子串 java解决
  • (剑指Offer)面试题41:和为s的连续正数序列
  • (离散数学)逻辑连接词
  • (论文阅读32/100)Flowing convnets for human pose estimation in videos
  • (求助)用傲游上csdn博客时标签栏和网址栏一直显示袁萌 的头像
  • (十二)python网络爬虫(理论+实战)——实战:使用BeautfulSoup解析baidu热搜新闻数据
  • (转)关于如何学好游戏3D引擎编程的一些经验
  • .net core MVC 通过 Filters 过滤器拦截请求及响应内容
  • .net core控制台应用程序初识
  • .NET Framework 3.5中序列化成JSON数据及JSON数据的反序列化,以及jQuery的调用JSON
  • .NET/C# 利用 Walterlv.WeakEvents 高性能地定义和使用弱事件
  • .NET/C# 异常处理:写一个空的 try 块代码,而把重要代码写到 finally 中(Constrained Execution Regions)
  • .NETCORE 开发登录接口MFA谷歌多因子身份验证
  • .NET的数据绑定
  • .NET连接数据库方式
  • .Net中间语言BeforeFieldInit
  • /bin/bash^M: bad interpreter: No such file or directory
  • /etc/fstab和/etc/mtab的区别
  • /etc/skel 目录作用
  • /usr/bin/python: can't decompress data; zlib not available 的异常处理
  • @Async注解的坑,小心
  • @cacheable 是否缓存成功_Spring Cache缓存注解
  • [2669]2-2 Time类的定义