使用Markdown Jekyll中的图像标题

时间:2013-10-12 06:42:59

标签: github markdown jekyll

我在Github上主持一个Jekyll博客并用Markdown写我的帖子。当我添加图片时,我会按照以下方式进行:

![name of the image](http://link.com/image.jpg)

然后显示文本中的图像。

但是,如何告诉Markdown添加图片下方或上方显示的标题?

13 个答案:

答案 0 :(得分:222)

我知道这是一个老问题,但我想我仍然会分享我添加图片标题的方法。您将无法使用captionfigcaption标记,但如果不使用任何插件,这将是一个简单的替代方案。

在降价标记中,您可以使用强调标记包装标题并将其直接放在图像下方,而无需插入新行,如下所示:

![](path_to_image)
*image_caption*

这将生成以下HTML:

<p>
    <img src="path_to_image" alt>
    <em>image_caption</em>
</p>

然后在CSS中,您可以使用以下选择器设置样式,而不会干扰页面上的其他em标记:

img + em { }

请注意,图片和标题之间不能有空行,因为这样会生成:

<p>
    <img src="path_to_image" alt>
</p>
<p>
    <em>image_caption</em>
</p>

您还可以使用除em之外的任何其他标记。只要确保有标签,否则你将无法设置标签。

答案 1 :(得分:73)

如果您不想使用任何插件(这意味着您可以直接将其推送到GitHub而不先生成网站),您可以在image.html中创建一个名为_includes的新文件:< / p>

<figure class="image">
  <img src="{{ include.url }}" alt="{{ include.description }}">
  <figcaption>{{ include.description }}</figcaption>
</figure>

然后使用以下标记显示降价图像:

{% include image.html url="/images/my-cat.jpg" description="My cat, Robert Downey Jr." %}

答案 2 :(得分:38)

您可以使用表格。它工作正常。

| ![space-1.jpg](http://www.storywarren.com/wp-content/uploads/2016/09/space-1.jpg) | 
|:--:| 
| *Space* |

结果:

enter image description here

答案 3 :(得分:27)

用于带字幕的图片的正确HTML是<figure> with <figcaption>

此处没有与Markdown等效的内容,因此,如果您只添加偶尔的标题,我建议您只将该html添加到Markdown文档中:

Lorem ipsum dolor sit amet, consectetur adipiscing elit...

<figure>
  <img src="{{site.url}}/assets/image.jpg" alt="my alt text"/>
  <figcaption>This is my caption text.</figcaption>
</figure>

Vestibulum eu vulputate magna...

The Markdown spec encourages you to embed HTML in cases like this,所以它会显示得很好。它比搞乱插件要简单得多。

如果您尝试使用其他Markdown-y功能(如表格,星号等)来制作字幕,那么您只是在讨论如何使用Markdown。

答案 4 :(得分:4)

您可以尝试使用pandoc作为转换器。 Here's a jekyll plugin来实现这一目标。 Pandoc将能够自动添加与alt属性相同的数字标题。

但是你必须推送已编译的站点,因为github不允许Github页面中的插件用于安全。

答案 5 :(得分:3)

我发现top voted answer的一个轻微的重复,我发现更明确的是使用jekyll语法将类添加到某个东西,然后以这种方式设置样式。

所以在帖子中你会有:

![My image](/images/my-image.png)

{:.image-caption}
*The caption for my image*

然后在您的CSS文件中,您可以执行以下操作:

.image-caption {
  text-align: center;
  font-size: .8rem;
  color: light-grey;

看起来很好看!

答案 6 :(得分:3)

<p align="center">
  <img alt="img-name" src="/path/image-name.png" width="300">
  <br>
    <em>caption</em>
</p>

这是基本字幕用法。不需要使用额外的插件。

答案 7 :(得分:2)

安德鲁的@ andrew-wei回答非常好。您也可以将一些链接在一起,具体取决于您要执行的操作。例如,这会在标题的不同部分为您提供带有换行符,标题和标题的图像以及换行符和粗体和斜体:

img + br + strong {margin-top: 5px; margin-bottom: 7px; font-style:italic; font-size: 12px; }
img + br + strong + em {margin-top: 5px; margin-bottom: 7px; font-size: 12px; font-style:italic;}

使用以下<img>降价:

![description](https://img.jpg "description")
***Image:*** *description*

答案 8 :(得分:2)

此问题在语义上有两种正确的解决方案:

  1. 使用插件
  2. 创建自定义包含

1。使用插件

我已经尝试了几个插件来进行此操作,并且my favourite is jekyll-figure也是如此。

1.1。安装jekyll-figure

安装jekyll-figure的一种方法是将gem "jekyll-figure"添加到插件组中的Gemfile中。

然后从您的终端窗口运行bundle install

1.2。使用jekyll-figure

只需将您的降价包装在{% figure %}{% endfigure %}标签中即可。

您的标题位于{% figure %}开头的标签中,甚至可以使用markdown设置其样式!

示例:

{% figure caption:"Le logo de **Jekyll** et son clin d'oeil à Robert Louis Stevenson" %}
    ![Le logo de Jekyll](/assets/images/2018-08-07-jekyll-logo.png)
{% endfigure %}

1.3。设置样式

既然图像和标题在语义上是正确的,则可以根据需要应用CSS:

  • figure(用于图像和标题)
  • figure img(仅适用于图片)
  • figcaption(仅用于字幕)

2。创建自定义包含

您需要image.html文件夹中创建一个_includes文件,并使用Markdown中的Liquid添加该文件

2.1。创建_includes / image.html

在_includes文件夹中创建image.html文档:

<!-- _includes/image.html -->
<figure>
    {% if include.url %}
    <a href="{{ include.url }}">
    {% endif %}
    <img
        {% if include.srcabs %}
            src="{{ include.srcabs }}"
        {% else %}
            src="{{ site.baseurl }}/assets/images/{{ include.src }}"
        {% endif %}
    alt="{{ include.alt }}">
    {% if include.url %}
    </a>
    {% endif %}
    {% if include.caption %}
        <figcaption>{{ include.caption }}</figcaption>
    {% endif %}
</figure>

2.2。在Markdown中,使用Liquid添加图像

/assets/images中带有标题的图像:

This is [Jekyll](https://jekyllrb.com)'s logo :

{% include image.html
    src="jekyll-logo.png" <!-- image filename (placed in /assets/images) -->
    alt="Jekyll's logo" <!-- alt text -->
    caption="This is Jekyll's logo, featuring Dr. Jekyll's serum!" <!-- Caption -->
%}

使用绝对URL的(外部)图像:(将src=""更改为srcabs=""

This is [Jekyll](https://jekyllrb.com)'s logo :

{% include image.html
    srcabs="https://jekyllrb.com/img/logo-2x.png" <!-- absolute URL to image file -->
    alt="Jekyll's logo" <!-- alt text -->
    caption="This is Jekyll's logo, featuring Dr. Jekyll's serum!" <!-- Caption -->
%}

可点击的图片:(添加url=""自变量)

This is [Jekyll](https://jekyllrb.com)'s logo :

{% include image.html
    src="https://jekyllrb.com/img/logo-2x.png" <!-- absolute URL to image file -->
    url="https://jekyllrb.com" <!-- destination url -->
    alt="Jekyll's logo" <!-- alt text -->
    caption="This is Jekyll's logo, featuring Dr. Jekyll's serum!" <!-- Caption -->
%}

没有标题的图像:

This is [Jekyll](https://jekyllrb.com)'s logo :

{% include image.html
    src="https://jekyllrb.com/img/logo-2x.png" <!-- absolute URL to image file -->
    alt="Jekyll's logo" <!-- alt text -->
%}

2.3。设置样式

既然图像和标题在语义上是正确的,则可以根据需要应用CSS:

  • figure(用于图像和标题)
  • figure img(仅适用于图片)
  • figcaption(仅用于字幕)

答案 9 :(得分:0)

这是最简单(但不是最漂亮)的解决方案:围绕整个事情制作一张桌子。显然存在扩展问题,这就是为什么我给出HTML示例,以便您可以轻松修改图像大小。这对我有用。

| <img src="" alt="" style="width: 400px;"/> |
| My Caption |

答案 10 :(得分:0)

对于 Kramdown,您可以使用 {:refdef: style="text-align: center;"} 对齐中心

{:refdef: style="text-align: center;"}
![example](https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg){: width="50%" .shadow}
{: refdef}
{:refdef: style="text-align: center;"}
*Fig.1: This is an example image. [Source](https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg)*
{: refdef}

您需要在帖子的开头添加 {::options parse_block_html="true" /} 才能生效。

答案 11 :(得分:0)

这个选项表面上看起来可能很复杂,但它根本不是,并且解决了 Jekyll Markdown 渲染器(Kramdown)存在的其他问题。基本上,此选项更改了使用可扩展的 Python 制作的渲染器,允许您安装扩展(例如,有大量的降价字幕)并扩展它(它有一个扩展 API)。

  1. 第一步是定义一个自定义的降价处理器。您必须将 markdown: CustomProcessor 添加到 _config.yml

  2. 然后,我们必须创建 CustomProcessor。创建一个名为 _plugins 的文件夹并添加一个名为 MyConverter.rb 的文件,其中包含以下内容:

class Jekyll::Converters::Markdown::CustomProcessor

    def initialize(config)

    end

    def matches(ext)
        ext =~ /^\.(md|markdown)$/i
    end

    def output_ext(ext)
        ".html"
    end

    def convert(content)

      puts "EXECUTED"

      md_path = "./_plugins/temp/temp.md"
      html_path = "./_plugins/temp/temp.html"
      
      File.write(md_path, content, mode: "w")
      system("python ./_plugins/MyConverter.py")

      content = File.read(html_path)
      content
    end
end

您还需要在 temp 内创建一个文件夹 plugins

所有代码所做的就是将我们正在处理的文件的所有内容写入 temp.md,调用 python 脚本,等待它完成,读取 temp.html,并将其作为转换器的输出返回。< /p>

  1. 现在是时候在 python 中创建我们的转换器了。我选择使用Python-Markdown。它易于使用并具有大量扩展。要使用转换器,我们必须在 MyConverter.py 文件夹中创建一个名为 _plugins 的文件并将此内容放入其中:
import markdown

markdown_extensions = [
    'markdown_captions',
    'def_list',
    'nl2br',
    'tables',
    'codehilite',
    'fenced_code',
    'md_in_html',
    'attr_list'
]

md_file = open("./_plugins/temp/temp.md", "r")
md_string = md_file.read()
md_file.close()

html_string = markdown.markdown(md_string, extensions=markdown_extensions, extension_configs =extension_configs)

html_file = open("./_plugins/temp/temp.html", "w")
html_file.write(html_string)
html_file.close()

该代码只是加载扩展,读取 temp.md 文件,将其转换为 html 并将其写入 temp.html。使用所有这些扩展应该会生成与默认 jekyll markdown 渲染器类似的输出。唯一没有与 python-markdown 捆绑在一起的扩展是 markdown_captions,这是一个神奇的扩展。要安装 Python 渲染器和扩展程序,您只需运行 pip install Markdown markdown-captions

应该可以了,现在您的 Markdown 正在由 Python-Markdown 翻译。一些 html 元素现在可能有所不同(根据我的经验,只有几个)所以也许您必须对 css 进行一些小的更改。

这是我在 Camptions 中使用的 css:

figure{
  margin: 0px;
}

figcaption { 
  color: gray;
  font-size: 0.8rem;
}

该过程尽量简单,以便于理解和修改。我已经描述了这个过程,就像我记得的那样。如果有人有问题,请发表评论,我会更新答案。

答案 12 :(得分:0)

_config.yml 文件中添加以下配置

# prose.io config
prose:
  rooturl: '_posts'
  media: 'img'
  ignore:
    - 404.html
    - LICENSE
    - feed.xml
    - _config.yml
    - /_layouts
    - /_includes
    - /css
    - /img
    - /js
  metadata:
    _posts:
      - name: "layout"
        field:
          element: "hidden"
          value: "post"
      - name: "title"
        field:
          element: "text"
          label: "Post title"
          placeholder: "Title"
          alterable: true
      - name: "subtitle"
        field:
          element: "textarea"
          label: "Subtitle"
          placeholder: "A description of your post."
          alterable: true
      - name: "date"
        field:
          element: "text"
          label: "Date"
          help: "Enter date of post."
          placeholder: "yyyy-mm-dd"
          alterable: true
      - name: "image"
        field:
          element: "text"
          label: "Image"
          help: "Add a thumbnail image to your post."
          placeholder: "Thumbnail"
          alterable: true
      - name: "published"
        field:
          element: "checkbox"
          label: "Publish"
          help: "Check to publish post, uncheck to hide."