标签: github-flavored-markdown

有没有办法在Github Wiki上显示进度条?

我想在Github Wiki上展示我项目当前迭代的进度.但是我找不到办法做到这一点.

我正在寻找类似于Bootstrap进度条的东西,没有任何交互.有一个简单的方法吗?

github twitter-bootstrap github-flavored-markdown

6
推荐指数
3
解决办法
2398
查看次数

使用github markdown语法引用一篇论文

我正在为github中的repo编写自述文件,我想添加对文章的引用.在引文中编码最合适的方法是什么?例如,作为一个块引用,作为代码,作为简单的文本等?

建议?

github github-flavored-markdown

6
推荐指数
3
解决办法
2528
查看次数

如何在github降价中转义括号

我在降价文本文件中有以下行:

[递归] ( http://en.wikipedia.org/wiki/Recursion_(computer_science) )

当它被渲染时,解析器通过选择第一个右括号而不是第二个来断开链接。

该链接最终为http://en.wikipedia.org/wiki/Recursion_(computer_science而不是 http://en.wikipedia.org/wiki/Recursion_(computer_science)

如何转义第一个右括号?

我试过使用反斜杠和反引号,但它们不起作用。

markdown github-flavored-markdown

6
推荐指数
1
解决办法
3758
查看次数

是否可以将一个 wiki 页面的内容包含在另一个 wiki 页面中?

Github wiki 是否可以在一个 wiki 页面中包含另一个 wiki 页面的内容?

wiki github github-flavored-markdown

6
推荐指数
1
解决办法
1250
查看次数

github markdown - 保留 Linux 终端输出

创建 github 风格的 markdown 时有没有办法保留终端输出的颜色?例如,如果我想包含一些终端示例,其中的结果ls对于目录、可执行文件等会有不同的颜色?

例如图像:

在此输入图像描述

github-flavored-markdown

6
推荐指数
1
解决办法
4203
查看次数

Sphinx扩展在Sphinx中使用GitHub markdown表情符号?

问题

我一直在使用(Python)Sphinx docCommonMark解析器来编写Sphinx文档,其中包含用reStructuredText和Markdown编写的文件。到目前为止,一切都很好,它确实很好用(请参阅Sphinx conf.py文件示例中的这一行)。

但是,CommonMark对GitHub风格的Markdown(GFM)的支持并不完美,而emoji是它缺少的一个重要功能。我搜索了其他Markdown解析器,更特定于GFM,例如py-gfm,但是它们似乎都不支持表情符号。

例如,下面的屏幕截图在左侧显示Sphinx输出,在右侧显示GitHub渲染的版本: 一个例子

所以我的问题是:

  • 是否有人知道Sphinx扩展可以在rST和/或Markdown中增加对类似于GFM的表情符号的支持?(即,这样写出的表情符号:boom:)。
  • 还是我可以用来将任何表情符号(例如)转换:boom:为小图像的技巧?(因为这就是GitHub上是无论如何做,例如见:boom:图像)的窍门也许应该对狮身人面像创建,而不是在源文件降价(我想他们仍然是可读与GitHub的文件浏览器)的HTML页面。

提前致谢。问候。


2部分解决方案

  • 部分解决方案是我使用carpedm20的emoji包编写的这个小型Python脚本。如果可能的话,它将把任何:emoji:别名(写成:like_this :)转换为UTF-8版本。

  • 我还尝试使用pymdownx.emoji包编写第二个脚本。它将把任何:emoji:别名转换为一段HTML代码,以加载一个遥远的PNG(或SVG)版本(来自JsDelivr的CDN)。仍然不够完美,大小/缩放比例不好,甚至...中的表情符号也被替换了。(我将对此进行改进)。

两者都可以与这个微小的Bash for循环一起使用:

BUILDDIR=_build/html  # Adapt to the location of your Sphinx output
for i in "$BUILDDIR"/*.html; do
    emojize.py "$i" > "$i".new
    # or emojize_pngorsvg.py "$i" > "$i".new
    wdiff -3 "$i" "$i".new;
    mv -vf "$i".new "$i"
done
Run Code Online (Sandbox Code Playgroud)

演示:

  • 使用用于表情符号的UTF-8代码: 一个例子2
  • 使用表情符号的PNG图像(仍不完美): 一个例子3

emoji python-sphinx github-flavored-markdown

6
推荐指数
2
解决办法
1057
查看次数

使用 JSON 时 Swagger 描述中的新段落

使用 JSON 在 Swagger 中编写描述时如何创建新段落?

我只找到 YAML 的示例,当我像使用 Markdown 一样创建一个新段落时,验证失败并且文档不再呈现。

我想要的是

第一段描述了调用。

另一段提供了有关通话的更多信息。

我尝试过但不起作用

"description": "The first paragraph describes the call.

Another paragraph gives additional information about the call.",
Run Code Online (Sandbox Code Playgroud)

json github-flavored-markdown swagger-2.0

6
推荐指数
1
解决办法
9089
查看次数

如何编写包含嵌套无序列表的有序列表(GitHub 降价)

从这里的文档:
https://guides.github.com/features/mastering-markdown/),
你可以创建一个缩进或低于其他项目多个列表项的嵌套列表。


在此处输入图片说明

但我正在尝试创建一个带有嵌套无序列表的有序列表。


我试过这个代码:

1. Ordered One
  * Unordered First
  * Unordered Second
  * Unordered Third
1. Ordered Second
  * Unordered One
  * Unordered Two
  * Unordered Three
Run Code Online (Sandbox Code Playgroud)

我得到的是:

在此处输入图片说明


我怎样才能写这个这样Ordered Second自动获取数字2.并且无序列表的嵌套列表正确缩进?

谢谢你。

markdown github github-flavored-markdown

6
推荐指数
1
解决办法
7078
查看次数

如何设置 Markdown 表格内图像的相对大小

我想让 Markdown内的图像具有相同的大小。但是,我拥有的图像资源大小不同。因此我想在表格单元格内设置相对图像大小。

如何在不实际更改图像资源大小的情况下使其Fig 2看起来像?Fig 1

|     |     |     |     |     |
| :-: | :-: | :-: | :-: | :-: |
|     |     |     |     |     |
| 180 | 182 | 240 | 250 | 250 |
| <img src="assets/textbooks/180.jpg" width="100%"> | <img src="assets/textbooks/182.jpg" width="100%"> | <img src="assets/textbooks/240.jpg" width="100%"> | <img src="assets/textbooks/250-1.jpg" width="100%"> | <img src="assets/textbooks/250-2.jpg" width="100%"> |
Run Code Online (Sandbox Code Playgroud)

图 1. 预期

(相同的代码,但实际图像资源具有相同的大小)

在此输入图像描述

图 2. 电流输出

(我目前拥有的)

在此输入图像描述

markdown github-flavored-markdown

6
推荐指数
1
解决办法
3018
查看次数

如何向 Markdown 文件添加页眉和页脚?

我有一个更一般的用例,当我将 Markdown 转换为 PDF 文档时,我需要将公司徽标添加到每个页面的页眉中。重要的是要注意,这不是最基本的问题,我只需要添加图像,而是需要类似于我们在 Word 文件中所做的页眉和页脚。

我试图找出解决方案,但我知道可以使用 Sweave 和 R Markdown。我的 Markdown 是 Github Markdown。

我使用 Typora 来实现降价,但 Typora 没有提供执行相同操作的选项。幸运的是,我发现可以通过向 VS-Code 添加扩展“Markdown-Pdf”来向 Markdown 添加页眉和页脚,但仍然无法配置页眉和页脚。

markdown-pdf的官方文档给出了markdown-pdf.headerTemplate的设置,但是给这个参数一个样式是行不通的。

markdown github-flavored-markdown

6
推荐指数
1
解决办法
1万
查看次数