标签: readme

我有一个 .mp4 格式的视频，我想将其插入 README.md 中以作为 vscode 的扩展。

我试图在 readme.md 文件中有一个下拉菜单，并在该可扩展区域中显示代码。

对于 md 文件，我看到有人使用对我有用的 ``` 。

下面的链接对于使用 md 文件和许多其他内容显示表格数据很有用：-

1. https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

2. https://github.com/tchapi/markdown-cheatsheet/blob/master/README.md

为了显示下拉菜单，我发现使用带有摘要的详细信息标签有效：-

Markdown 中的可折叠标题为 html

我正在尝试更新 md 文件并显示一些代码

<details>
  <summary><h1 style="display:inline-block"> Advanced Topics </h1></summary>
    ```

    import { Component } from '@angular/core';

    @Component({
      selector: 'app-root',
      template: `<nav>
                  <a routerLink="/signin" routerLinkActive="active">SignIn</a>
                  <a routerLink="/signup" routerLinkActive="active">SignUp</a>
                </nav>  
                <router-outlet></router-outlet>`,
      styleUrls: ['./app.component.css']
    })
    export class AppComponent {
      
    }


    ```
</details>

但到目前为止我还没有成功。

如何显示格式化/突出显示的代码，就像我在详细信息标签内使用 ``` 时一样？

任何帮助，将不胜感激。

在 GitHub 或 BitBucket 中每个存储库的主页上，它都以非常漂亮的格式显示 Readme.md。

有没有办法用红宝石做同样的事情？我已经找到了一些像Redcarpet这样的宝石，但它看起来从来都不漂亮。我已按照Redcarpet 的说明进行操作。

编辑：在我尝试了Github 的标记 ruby​​ gem后，同样的事情发生了。显示的内容是这样的： 我想要的是这样的：

我确信这不仅仅是缺少 css，因为在 3 个反引号 (```) 之后，我编写了类似jsonor 的语法bash，并且在第一个图像中编写了它。

编辑2：

这段代码在这里：

  renderer = Redcarpet::Render::HTML.new(prettify: true)
  markdown = Redcarpet::Markdown.new(renderer, fenced_code_blocks: true)
  html = markdown.render(source_text)
  '<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>'+html

生成了这个：

我想在 GitHub 的 README.adoc 文件中居中对齐图像。

我知道对于 Markdown 文件，添加 HTML如下所示：

<p align="center">
  <img width="460" height="300" src="http://www.fillmurray.com/460/300">
</p>

但是，我想在 AsciiDoc 中编写文件，而不是 Markdown。

我已经尝试过但没有奏效

假设在与 README 相同的目录中有一个 map.png 图像。

image::map.png[A map, 350, align=center]

这将显示正确的图像，但与左侧对齐。

我在裸存储库中使用 git 管理我的点文件。有关此方法的详细信息，请参阅Harfang Perch 的文章。

它工作得很好，但我想将 README.md 添加到github 上存储库的根目录。

如何添加一个README.md到GitHub的版本库的根目录，但不具有该文件在我的主目录显示？

如果我将 README.md 推送到 github 然后删除我的主目录中的 README.md 这将导致

deleted:    README.md

从消息git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME status我宁愿避免。

据我所知，github 仅在存储库根目录（和子目录，但这与此问题无关）中呈现 README 和 README.md 文件。

我还没有看到其他带有 README.md 文件的 github dotfile 裸存储库，但我只检查了 5 个。

Github wiki 页面不能解决这个问题，除非有一些魔法可以使用隐藏的 .dotfile 将它们显示在存储库的根目录中。也许我正在抓住稻草，但是，有什么方法可以在 github 上的存储库根目录中链接和显示要点？

我目前不使用 gitlab，但如果他们支持 github 不支持的 gitlab 或类似的 git 托管服务，则有可能转移到 gitlab 或类似的 git 托管服务。

我计划在我的一些README.md文件中做的是提供我引用的其他网站的超链接.但是,当链接死亡或被移动时,我们都遇到了这个问题,并且所述链接变得无效.=(

是否有一个github工具可以运行夜间检查,以查看README.md文件中的所有链接(或类似的东西)是否正常工作？

我正在寻找的是具有类似于Travis CI的功能,其中一个项目可以在项目的主要github页面上有一个标记"链接传递".(例如:scikit-learn有两个优雅的"构建传递"徽章.)

我在github上格式化README时遇到一些问题。

这是原始的自述文件：

| Italic             |  Block letters |
:-------------------------:|:-------------------------:
![](outputs/output_Biotouch/18-15_02-02-2018/Identification/ITALIC/ITALIC_movementPoints_cmc.png)  |  ![](outputs/output_Biotouch/18-15_02-02-2018/Identification/BLOCK_LETTERS/BLOCK_LETTERS_movementPoints_cmc.png)
![](outputs/output_Biotouch/18-15_02-02-2018/Verification/ITALIC/ITALIC_movementPoints_notbalanced_roc.png)  |  ![](outputs/output_Biotouch/18-15_02-02-2018/Verification/BLOCK_LETTERS/BLOCK_LETTERS_movementPoints_notbalanced_roc.png)
![](outputs/output_Biotouch/18-15_02-02-2018/Verification/ITALIC/ITALIC_movementPoints_notbalanced_frrVSfpr.png)  |  ![](outputs/output_Biotouch/18-15_02-02-2018/Verification/BLOCK_LETTERS/BLOCK_LETTERS_movementPoints_notbalanced_frrVSfpr.png)

它只是一张具有对某些图像的相对引用的表。

参考的图像具有相同的尺寸。

结果如下：

为什么中间行中包含的图像较小？

我负责在我们公司发布的一个库作为 NuGet 包，我按照“添加自述文件和其他文件”指南显示了一个 readme.txt，其中包含用户在使用 Visual Studio 时安装或更新包时的重要更改。这有效 - 即当您安装软件包时，会显示 readme.txt。然而，当你安装这个包时，这个 readme.txt 文件也会被复制到目标项目的根目录中。

有谁知道我怎么能阻止这个（即在安装时显示 readme.txt，但不要将它添加到目标项目中）？用户查看此文件非常有用，但如果将其添加到项目中会令人困惑。

库的 .nuspec 如下所示：

<?xml version="1.0"?>
<package >
  <metadata>
    <id>$id$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <projectUrl>http://example.com/blah/blah</projectUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>$description$</description>
  </metadata>
  <files>
    <file src="README.txt" target="" />
  </files>
</package>

打包 + 推送通常由 TeamCity 构建步骤执行，但如果我使用以下命令行构建 pkg，则会出现相同的行为：

$ nuget pack MyLibrary.csproj
$ nuget push MyLibrary-{version}.nupkg -source {internal-nuget-server}

我R在GitHub上有一个要提交给CRAN 的软件包。到目前为止，该程序包已经包含了一个扩展的README.md文档，其中显示：

• 包核心功能执行的示例，
• 包演示执行的示例
• 一些基准测试结果。

对于GitHub用户而言，我认为将它们放到README.md上比装饰插图更具吸引力，因为它在用户查看软件包的回购协议时会显示出来。

当我打算将包移到CRAN时，我希望拥有与README.md中当前几乎相同的内容，并以小插图的形式提供。

问题：将README.md的近1-1副本制作成小插图，同时保留两者，更新GitHub repo以使其也具有小插图，然后将其提交给CRAN，这是一种正确的操作方式吗？或者：是否会造成重复，不应该发生？（那我应该如何进行？）

我知道如何在 R Studio 中进行 R-CMD-check 并且它全部通过了。

但是，我希望在 README 文件中为Github上的包添加此 R-CMD-check“通过”状态