Search code examples
githubmarkdownjekyll

Jekyll markdown processing does not create hyperlink

I am trying to create a simple website for documentation using github page using markdown documents.

The directory structure is:

root
 |-- index.md
 +-- _topic
       |-- doc1.md
       |-- doc2.md
       |-- ...
       +-- docn.md

The index.md file content:

---
title: TOC
---

{% for topic in site.topics %}
* [{{topic.title}}]({{topic.url}}] 
{% endfor %}

I was expecting the produced html will contain a list of hyperlinks since markdown uses []() for hyperlinks. Instead I see the following in Jekyll generated index.html:

<ul>
  <li>
    <p>[doc1_title](/topics/doc1.html]</p>
  </li>
  <li>
    <p>[doc2_title](/topics/doc2.html]</p>
  </li>
  ...
  <li>
    <p>[docn_title](/topics/docn.html]</p>
  </li>
</ul>

Any ideas what am I doing wrong here?

Solution

  • You could try 

     {{ topic.url | relative_url }}

    which should give you the relative url of your topic