npm学习（九）之README.md文件

包括文档(readme.md)

npm建议您包含一个readme文件来记录您的包。自述文件必须有文件名readme.md。文件扩展名.md表示该文件是一个标记(markdown)文件。当有人发现您的包时，该文件将出现在npm网站上。在开始之前，请查看一些包页面，了解可以添加到readme文件中的信息，并了解为什么这一点如此重要。　

使用任何文本编辑器创建文件。
将它保存在项目目录中，名称为readme.md
发布时，此文档将显示在下载包的web页面上

如何更新ReadMe文件

除非发布包的新版本，否则不会更新站点上显示的自述文件，因此需要运行npm version patch和npm publish来更新站点上显示的文档。

原文地址：https://www.cnblogs.com/kunmomo/p/11221880.html

时间： 2024-11-05 02:19:01

npm学习（九）之README.md文件的相关文章

关于github中的README.md文件

0x01 README.md文件是用Markdown语言编写的,md=Markdown; 在线编辑工具: https://stackedit.io/editor# https://maxiang.io/#笔记本和标签关于使用语法的说明: https://github.com/guoyunsky/Markdown-Chinese-Demo 0x02 Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,

原来Github上的README.md文件这么有意思——Markdown语言详解（sublime text2 版本）

一直想学习 Markdown 语言,想起以前读的一篇赵凯强的博客 <原来Github上的README.md文件这么有意思——Markdown语言详解>,该篇博主使用的是Mac系统,所以推荐使用Mou,本人使用 Win7 系统所以想写一篇 sublime text2 的版本

原来Github上的README.md文件这么有意思——Markdown语言详解

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解.但是在看到别人写的项目的README.md里面竟然有图片.链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果, 竟迁出了一门从来没有了解过的语言— —Markdown! github上的README.md文件就是使用的Markd

（转）为项目编写Readme.MD文件

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

为项目编写Readme.MD文件(转自OneCoder)

点击原文--->为项目编写Readme.MD文件两个Markdown的编辑器. 在线编辑器:stackedit网址:https://stackedit.io/ Mac下离线编辑器Mou下载地址:http://mouapp.com/ 也可以手动用语法写,下面是语法 Markdown 语法速查表1 标题与文字格式标题# 这是 H1 <一级标题>## 这是 H2 <二级标题>###### 这是 H6 <六级标题>文字格式**这是文字粗体格式***这是文字斜体格式*~~

github中readme.md文件的修改

研究了一下github上readme.md文件的修改删除,只能说如果是第一次还真找了一会. 删除就在旁边重新提交就ok了!

Gitee中 README.md文件的编辑和使用

最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们该文件用来测试和展示书写README的各种markdown语法.GitHub的markdown语法在标准的markdown语法基础上做了扩充,称之为GitHub Flavored Markdown.简称GFM,GFM在GitHub上有广泛应用,除了README文件外,issues和wiki均支持markdown语法. 开始编辑README 当没有README文件的时候我们可以添加一个README

git中由readme.md文件引发的问题

在GitHub上建立一个仓库并且添加了readme.txt文件. 无论是push前先将远程仓库pull到本地仓库,还是强制push都会弹出这个问题. Github 禁用了TLS v1.0 and v1.1,必须更新Windows的git凭证管理器,才行. 1.先拉下来,会自动合并git pull origin master 2.然后在进行上传git push -u origin master 原文地址:https://www.cnblogs.com/tulintao/p/11448898.htm

README.md文件 github Markdown语言详解 md文件用法和说明

本人使用.md文档完全为了记录日常的编译和工作中遇到的问题,需要用到的功能大概就是常用的语法,强调,引用,代码,链接等.对于图片的插入需求不高,因此本文主要介绍一些语法特点,最后涉及一点可能用到的其他功能. 000-->功能函数详细条目: 区块元素段落和换行一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行.比方说,若某一行只包含空格和制表符,则该行也会被视为空行).普通段落不该用空格或制表符来缩进. 「由