标签: readme

如何在 GitHub readme.md中创建链接以在新选项卡中打开链接

[my website](www.google.com)

我已经在 Github 上为我的项目创建了 MIT 许可证。它添加了一个许可证文件，现在显示为 MIT 许可证。

我访问了 Shields.IO，它建议了我的存储库的链接。其中之一是执照徽章。

我已使用标记将其添加到我的自述文件中，并且除许可证徽章之外的所有其他徽章均有效。

我还通过请求特权来允许向我的 Github 发起屏蔽请求。

我还需要做些什么才能让它发挥作用吗？

我假设 Shields 会读取存储库内的 Github 许可证文件来获取许可证类型？

我如何在 github 自述文件中并排嵌入 2 个视频，以便在此示例中 MixtureVariants 和 Earth Heightmap 节点视频将是其当前宽度的一半并彼此相邻放置。

我知道有几个名称被 GitHub 识别为 README，例如 README、README.md。
这些名字的详尽列表是什么？

这里描述了一种向 Github 中的 Markdown 文件添加图像的方法。但是，我想将图像添加到*.orgGitlab 中的文件（Github 和 Gitlab 支持README.org文件，因此两者的解决方案应该相同）。我试过了：

[[file:./path/to/file.svg]]
[[sometext][file:./path/to/file.svg]]]
[[file:./path/to/file.svg]][sometext]]

Markdown 的格式也不起作用：

![alt text](./path/to/file.svg)

建议使用现在删除的答案

![][1]

[1]: ./path/tofile

这也不起作用。

正确的做法是什么？

你如何使用带有HighlightJS标记的npm ？我正在尝试自动解析和设置我的文档。查看标记文档中的以下示例：

// Using async version of marked
marked(markdownString, function (err, content) {
  if (err) throw err;
  // console.log(content);
});

// Synchronous highlighting with highlight.js
marked.setOptions({
  highlight: function (code) {
    return require('highlight.js').highlightAuto(code).value;
  }
});

console.log(marked(markdownString)); 

我不知道如何使用README.md文件而不是带有手动转义特殊字符的字符串。使用示例不涉及对.md文档的任何引用作为markdownString.

如何将 Markdown 字符串作为文档（如形成一个名为 的文件README.md）而不是手动转义的字符串传递，并且最终输出还包括样式？

目标是能够传入一个 linted（我正在使用 VS 代码markdownlint）README.md、主文档 CSS 和/或 highlightJS css 并具有最后一行的返回值 ( marked(markdownString)) 是我可以直接写入的内容.html文件。

另一个注意事项：我的降价文件还指定了多行代码块中的语言。例如，我的 README.md 中的多行 JSON 块如下所示：

**BODY**:  

```JSON
{
  "username": "example@example.com",
  "p2setting": "4xx72" …

我正在尝试使用美人鱼在markdown文件中呈现流程图。我的GitHub存储库中有一个ReadMe.md文件，并且我想提供一个基本流程图来帮助描述内容。但是我不知道如何使它工作。有人能够发布一些更具体的说明，以呈现一个简单的示例吗？

在此链接（https://unpkg.com/mermaid@8.0.0-rc.8/README.md）中，有一个有关Mermaid安装的示例代码片段：

    ```
    https://unpkg.com/mermaid@7.1.0/dist/
    ```

我包含了该代码，然后尝试在下一个代码段中制作流程图：

    ```
    graph TD;
        A-->B;
        A-->C;
        B-->D;
        C-->D;
    ```

但是它所做的只是在我预览时在markdown文件中打印出该文本。

似乎有可能基于《美人鱼自述》：https : //github.com/knsv/mermaid/blob/master/README.md。但是，当我查看代码时，它实际上是流程图的图片，而不是代码的呈现。所以也许我要问的是不可能的？

将不胜感激！

我的自述文件中有一个 CircleCI 徽章，它只是通过以下方式检索到的：

<img src="https://circleci.com/gh/ORESoftware/live-mutex.png?circle-token=8ee836581">

有没有办法只为某个分支检索徽章？有没有办法让它保持更新？有时它会滞后 - 可能是因为 http 缓存。

我有两句话喜欢并排放置。我无法像 word doc 那样使用“\t”在它们之间添加制表符空间。当我给出一个长空格时，它预览为只有 1 个空格。因此，请在 github readme 中了解如何添加制表符空格。

示例：

“这是一个球”“\t”“这是一个球棒”。

如果已经提出类似的问题，我深表歉意，但我还没有找到。

我想将默认的项目描述文件名（称为README.md）更改为自定义名称（比方说XXX.md），我想知道是否有可能成为XXX.md该项目的初始自述文件（典型情况：您打开项目代码页您将XXX.md在底部看到 down 的内容）。

我想验证这种方法是否可行，但我主要对 Github 和 Bitbucket 服务感兴趣。我简要检查了项目设置，但找不到此类自定义。有可能吗？