问题标签 [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 回答
27479 浏览

pdf - 如何在我的 github 存储库中使用 pdf 文件作为自述文件?

我有一个由 Latex 生成的 pdf 文件,其中有很多方程式,什么没有。我想将此 pdf 用作我的 github 存储库中的 readme.md 文件。我怎样才能做到这一点?

或者,是否可以直接将 tex 文件集成到 github 中并将其用作自述文件而不是 pdf 版本?github 是否像 gmail 那样允许与乳胶语法进行任何集成?

0 投票
1 回答
795 浏览

visual-studio - Force a file to open when a solution file (.sln) is opened

I know that Visual Studio stores and persists opened files in the *.user files that it generates, but these files are not supposed to be checked in to TFS or shared between a team.

We have README.md files that are "solution items" in a lot of our solutions in TFS. What I want is, when a solution is opened, have the README.md file open if it is not open already. (Sort of mimicking how GitHub shows you the readme file when you browse to the project homepage, but this is strictly TFS and Visual Studio.) Documentation is huge for us, so we want to forcibly display it to anyone who opens a solution, making it hard to miss.

Is this possible with any sort of configuration line in the .sln file, or an XML entry in a .csproj file, or possibly an extension? I would like this to be something that can persist between different workstations using TFS (unless it's just an extension, in which case we can all install that).

0 投票
1 回答
896 浏览

git - 同一产品的不同主分支中的 github ReadMe.md 可以不同吗?

我在我的主分支中开发。我的同事在他们的个人主分支中发展。我们将其合并到组织主分支中(这简化了 AppVeyor、TravisCI 和其他服务的使用,还允许拥有仅用于每个开发人员文档的并行分支)。合并 ReadMe.md 很痛苦。是否有可能:

  • 不自动合并 ReadMe.md 文件?
  • 使部分 ReadMe.md 有条件(例如,如果自述文件在 B/master 中,则执行此操作,如果在 B/master 中,则执行此操作)?
0 投票
3 回答
1057 浏览

image - 高质量 GIF 文件的工具

我想在我的README中添加一些GIF文件。

请帮我创建一些GIF文件:

  • 合并PNG图像。
  • 将视频转换为GIF

我看过一些60fps 4k gif文件,但我知道它们是假的。例如 9gag 使用<video>带有mp4视频源的标签。

我无法将视频直接嵌入到我的自述文件中。

我只想要简短(2-5 秒)的视频。

将动画添加到 github README 文件的最佳方法是什么?

0 投票
1 回答
90 浏览

c# - 序列化 c# 使用 switch 序列化一个自述文件

我开发了一个应用程序,它为我组织内部的其他开发人员提供回归测试功能,他们通过应用程序前端进行交互的主要方式是通过硬编码字符串,这些字符串对应于代码中的 switch case 结构,如下所示:

序列化案例下方的名称和注释以在每次构建时生成某种自述文件的最佳方法是什么?在此示例中,我想生成一个如下所示的文件:

感谢您提供的任何帮助

0 投票
1 回答
612 浏览

github - github.com 块引用内的高级降价

我正在README.md为我的一个存储库写一个github.com.
作为其中的一部分,README.md我想包含另一个README.md(来自另一个存储库)的引用,这意味着在引用中使用高级降价。

最终我想看到这样的东西:


  • 项目 1
    • 使用以下内容:
      • 第一级引用列表
        • 二级引用列表
        • 嵌套报价

  • 第 2 项

现在我正在尝试通过以下降价来实现这一目标:

有几个在线 Markdown 编辑器打算模拟githubMarkdown 行为:一些github它自己工作得更好,一些更现实一些,但github看起来像这样:


  • 项目 1
    • 使用以下
      > * 第一级引用列表 > * 第二级引用列表 > * > 嵌套引用
  • 第 2 项

所以它似乎github支持块引用内的一些简单降价(如粗体、斜体等),但它不支持高级降价(如列表、引号等)

有什么方法可以引用复杂的降价github吗?

0 投票
3 回答
6604 浏览

github - 如何在 shields.io 徽章中使用“徽标”选项?

如何使用shields.io 徽章logo中的选项?

例如,像这样

呈现为这样

树莓派

这没有给出预期的结果。

0 投票
5 回答
142599 浏览

github - 如何在 Github 的 README.md 文件中显示表格?

我想在 readme.md 文件中显示一个表格。我阅读了GitHub Flavored Markdown并按照它所说的进行操作。所以这是我的桌子:

但是,我没有看到任何表格,结果如下:

在此处输入图像描述

0 投票
1 回答
333 浏览

github - 如果 repo 自动查看自述文件,则自述文件中的相对链接已损坏

我在 github 上有一个 repo 作为组织的一部分。例如:

MYORGANIZATION/MyRepository

repo 包含一个 README.md 文件。

在这个 README.md 文件中,我有一个链接,因此另一个 .md 文件位于与 README.md 相同的文件夹中的同一仓库中:

/README.md /anotherMarkdown.md

README.md 包含到另一个Markdown.md 的相对链接(如此处所述:https ://help.github.com/articles/relative-links-in-readmes/ ):

如果我使用此 URL 打开自述文件,则相对链接有效:

https://github.com/MYORGANIZATION/MyRepository/blob/master/README.md

链接指向:

https://github.com/MYORGANIZATION/MyRepository/blob/master/anotherMarkdown.md

如果我打开存储库 URL https://github.com/MYORGANIZATION/MyRepository/,则会显示存储库的根目录以及文件列表下方的自述文件。

但是上述相对链接现在已断开(给出 404)并指向:

https://github.com/MYORGANIZATION/MyRepository/anotherMarkdown.md

这是预期的行为吗?我的链接有什么问题?

0 投票
1 回答
33 浏览

xcode - Xcode 以前的版本有什么新功能?

Apple 之前在以下位置发布了“Xcode 7 中的新增功能”信息页面:

https://developer.apple.com/library/ios/documentation/DeveloperTools/Conceptual/WhatsNewXcode/Articles/xcode_7_0.html

…但是现在该 URL 报告了一个错误,“抱歉,找不到该页面。”。

开发人员如何学习或重新学习 Xcode 中添加的各种功能?