写markdown用于Github上readme.md文件

Markdown 文档地址 http://pan.baidu.com/s/1o6nu9To

Markdown还有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,同时,也能让Markdown转换成更多的格式,例如LaTeXDocbook。Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如Pandoc;要么基于网站,如GitHubWikipedia,在语法上基本兼容,但在换行等细节上也有改动。

 

以下是本人所写的markdown文件,用于在github上开源代码的说明:

#ListObjectOperation
![image](http://images.cnitblog.com/i/607542/201403/141558148063393.gif)

将字典与存储在磁盘上的NSData绑定,操作字典的同时也在修改存储在磁盘上的NSData.使用简单,用来替换系统的NSUserDefaults.

 * easy to store dictionary to file system
 * you can use it to replace NSUserDefaults

You can use like this:
```javascript
// store a dictionary to file system
[ListObjectOperation storeDictionary:@{@"name": @"YouXianMing"}
                              toPath:simpleFilePath(@"/Library/Preferences/data")];

// recover dictionary from file system and manage it
[ListObjectOperation syncDictionaryWithDataPath:simpleFilePath(@"/Library/Preferences/data")
                                           save:YES
                                     dictionary:^(NSMutableDictionary *list) {
                                         [list setObject:@"Y.X." forKey:@"name"];
                                     }];

// check the result
[ListObjectOperation syncDictionaryWithDataPath:simpleFilePath(@"/Library/Preferences/data")
                                           save:NO
                                     dictionary:^(NSMutableDictionary *list) {
                                         NSLog(@"%@", list);
                                     }];
```
Just use it for fun :).

以下图片为显示效果:

 

 

附录:

提供一个工具来编辑Markdown文件 - http://mouapp.com

这是这个应用的截图:

 

 

时间: 2025-01-31 01:23:48

写markdown用于Github上readme.md文件的相关文章

为项目编写Readme.MD文件

了解一个项目,恐怕首先都是通过其Readme文件了解信息.如果你以为Readme文件都是随便写写的那你就错了.github,oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的.称之为Markdown语法.基本规则如下: Markdown 语法速查表 1 标题与文字格式 标题 # 这是 H1 <一级标题> ## 这是 H2 <二级标题> ###### 这是 H6 <六级标题> 文字格式 **这是文字粗体格式** *这是

半自动化生成README.md文件

前言 实现 获取指定路径下所有文件的全路径 获取文件描述信息 生成readme 效果 总结 前言 最近一直在准备面试啊笔试啊什么的,写着写着代码就很多了.又不能每一个代码都写成博客,要不然质量也没法保证.于是想着在GitHub上建一个repository好了.整理进去,也保证了代码的安全性,万一以后要复习了也很方便. 但是面临的一个问题就是"懒",面对看起来蛮多的文档,一个一个的写标签似乎不是合适的选择,所以还是让程序帮我自动生成吧. 实现 实现所需步骤如下: 获取给定路径下的所有文件

github 上放ACCESS文件 本地delphi调用

问题描述 github 上放ACCESS文件 本地delphi调用 请问,我想把一个ACCESS文件放在gitbub上,然后本地写的delphi程序来连接它, 读取和修改数据,这样可以实现吗? 刚接触gitbub,不懂,求教. 解决方案 gitbub上必须有一个程序,执行网络连接和对数据库的操作,delphi写的本地程序通过服务器上的程序来实现对数据库的修改 解决方案二: http://developer.51cto.com/art/200510/7418.htm 可以下载上传.但是这不是好办法

如何编写github项目的README.md文件?

针对中文,演示Markdown的各种语法 具体的项目效果可以参考:https://github.com/guoyunsky/Markdown-Chinese-Demo   大标题 ===================================   大标题一般显示工程名,类似html的\<h1\><br />   你只要在标题下面跟上=====即可     中标题 -----------------------------------   中标题一般显示重点项,类似html的

求教一下怎么用github上的shipyard文件来进行本地部署

问题描述 问一下有人知道怎么用本地的包去安装部署shipyard么,我想对源码进行修改然后安装修改后的shipyard要怎么来?

【转载】花20分钟写的-大白话讲解如何给github上项目贡献代码

      本文献给对 git 很迷茫的新手,注意是新手,但至少会点基本操作,有点基本概念的新手,我不会从怎么用 github 和 git 是什么开始讲的.如果作为新手你看书又看不进去,原理又太复杂,有没有直接了当告诉我们怎么给项目贡献代码,并和项目同步代码的大体流程.于是我快速写了这么个东西.一来整理下自己混乱的思路,二来想号召大家一起用 git 开发点东西,可是好几个同鞋只会寂寞的给自己 push.  我先说下 我之前对 github 操作的一些迷茫历程,然后之后是怎么解惑的.  1. 最最

如何将.md文件传到github的仓库?

问题描述 如何将.md文件传到github的仓库? 刚开始用github,用msysgit按该网址操作http://jingyan.baidu.com/article/f7ff0bfc7181492e27bb1360.html,可是输密码的时候输不了,是什么原因?还是这个方法不对,需要一些其他的配置? 解决方案 如果你是做Java的,可以直接用idea,对github上的项目进行操作. 本地修改之后,要用git add xx文件,然后才可以进行提交到远程仓库. 解决方案二: 先看你的远程仓库路径

github上-“.mk”文件怎么编译用什么工具

问题描述 ".mk"文件怎么编译用什么工具 github上一个工具. 是一个用来监控Android的apk文件的. 请问这个源码怎么编译?

C#写的自定义控件用于网页上

问题描述 有谁用C#写过自定义控件然后用于网页上吗想知道如何将自定义控件用于网页的方法--要可行的--我百度过一些解决方法,但是都不能成功地将控件在网页上显示出来,更不用说运用其功能.ps:自定义控件在windows窗口(winform)中可以成功使用. 解决方案 解决方案二:补充一下:编程工具为VS2010解决方案三:此功能已被标记为过时,默认情况下被禁用.要改客户端注册表设置EnableIEHosting,对于企业用户还可以做到,对于外部消费者基本不现实.解决方案四:在你的网站项目中右键添加