问题标签 [readme]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
265 浏览

ruby-on-rails - Rails 何时生成 readme.md(而不是 readme.rdoc)?

我注意到,当我生成一个新的 Rails 应用程序时,有时我会得到一个 readme.md,有时会得到一个 readme.rdoc(Bitbucket 显然不会自动呈现)。

如果您对此有任何想法,请告诉我。

0 投票
2 回答
18497 浏览

github - 从 Markdown 文件到 Repo 根的相对链接

我需要有一个从降价文件到我的回购根目录的相对链接

(我需要它适用于任何叉子)

因此,它看起来像是在根目录中提供指向某个文件的链接的唯一方法:

the [Root](/README.md)

或者

the [Root](../README.md)

(例如,如果它位于 /doc/README.md 中)

同时我可以在不引用文件的情况下引用任何文件夹

the [Doc](/doc)

但是,如果我尝试将链接指向根文件夹:

the [real root](/)

the [real root](../)

我会有这样的链接

https://github.com/UserName/RepoName/blob/master _

这不像

https://github.com/UserName/RepoName/blob/master/doc _ _

指404

因此,如果我不想在根目录中引用 README.md (我可能根本没有)

有没有办法有这样的链接?

0 投票
1 回答
5913 浏览

git - 如何在 Git 中终止进程

大家好,我正在练习 git,我编辑了一个文件,我想提交我的修改,但它打开了一个消息编辑器 bash 寡妇你无法关闭它,直到我关闭 bash 终端。我再次打开它 n 想重新提交它给了我这个消息

标签

我怎么能终止这个过程,我删除了文件 n 试图创建一个新但仍然相同的任何提示?谢谢你们的帮助

0 投票
1 回答
1981 浏览

git - 如何在 VS Preview 和 TFS 欢迎页面中查看自述文件

当我使用 Team Foundation Server 和 Visual Studio 创建项目时,README.md会自动生成 a 并将其放置在项目文件夹的顶层(与 位于同一文件夹中.sln

这很棒,因为它允许我在项目的欢迎页面上显示上述自述文件:

在此处输入图像描述

但是,这意味着当我在 Visual Studio 中打开此项目时,我看不到自述文件,因为解决方案资源管理器的范围为解决方案下方的文件夹:

在此处输入图像描述

这并不理想,因为这意味着我无法使用 Markdown 预览扩展在 Visual Studio 中预览自述文件​​。

我的问题是:有没有办法将自述文件放在一个位置,以便我可以在 TFS 和 Visual Studio 中预览它?请注意,虽然我使用 TFS 来托管我的存储库,但我使用Git进行源代码控制而不是 Team Foundation Server 版本控制。

我已经尝试过的:

  1. 如上面的第二个屏幕截图所示,我teatreadme.md在项目文件夹中添加了一个,希望随后可以将其添加到 TFS 的欢迎页面中,但是我看不到这样的选项。
  2. 我尝试将范围限定到 Visual Studio 中的顶级文件夹,但这是不允许的
  3. 在解决方案资源管理器中选择“显示所有文件”,但这不会显示README.md
0 投票
1 回答
2742 浏览

github - GitHub 支持 README 的文件类型

我注意到 GitHub README 使用了许多不同的文件类型。最常见的是.md.rst

查看 GitHub 文档和帮助页面后,我发现没有关于允许哪些文件类型的信息。

我只是在寻找类型列表,以便找出可以用于下一个 README 的类型。

0 投票
5 回答
3215 浏览

github - 如何为 github 和 npm 指定不同的自述文件

README.md当您发布时,两者都使用作为描述。一种常见的做法是使用单个共享文件。

但是,如果我需要不同的自述文件并且仍然从单个本地存储库中发布它而不需要手动编辑/替换怎么办?

附言

我尝试"readme": "npm-readme.md"在 package.json 中使用,但它显示了该字段的值,而不是文件的内容

0 投票
1 回答
1256 浏览

setup.py - 如何使用 setup.py 将 README.md 文件包含在 PyPI 模块包中?

我想在README.md我的 PyPI 模块包中包含一个文件,以便我的setup.py. 但是,对我来说,如何获取setup.py相关基础设施以实际包含该README.md文件并不明显。

我在我的包中包含了一个MANIFEST.in文件,该文件本身列出README.md,并且我已将setuptools.setup参数设置include_package_data为,True但这不起作用。

manifest.in

setup.py

我用来注册和上传模块到 PyPI 的命令如下:

0 投票
1 回答
457 浏览

github - shields.io 上的某些徽章如何避免在其网址中使用 base-64

我正在尝试使用 shields.io 为我参与的 GitHub 项目创建徽章 。Shields.io允许您使用 base-64 编码添加徽标。很酷,但是将其放入自述文件中非常笨拙。考虑到我想让相关项目方便地将我们的徽章粘贴到他们的项目中,我不希望降价有十行长。

我注意到不是每个人都有这个问题。例如,Gitter 的盾牌有一个非常简单的 url,其中包含一个徽标。

Bithound 还有一个非常漂亮的徽章网址。

这些是他们与Shields.io 达成的特别优惠吗?还是每个人都可以使用这种光滑度?

0 投票
2 回答
5970 浏览

github - 来自第三方网站的大 gif 没有显示在 github 的 README.md 中?

我想在 github 的 README.md 中显示一个 gif。当目标 gif 较小时,它可以正常工作:

但是当 gif 很大时,它并没有按预期显示,以这个gif为例。当我将它添加到 README.md 中时,它只显示:

在此处输入图像描述

点击后,它会显示一个带有提示的网站

超出内容长度

由于 gif 来自第三个站点,我无法更改其大小。

那么,是否可以在不保存和调整大小的情况下显示这个大 gif?

0 投票
1 回答
697 浏览

javascript - 显示来自 github api 的自述文本

当点击 API 以获取自述文件以在此处做出反应时:https://api.github.com/repos/facebook/react/readme

我不知道如何处理"content"字符串中的 base64 编码文本。

有谁知道怎么做?