Jekyll - How to use a markdown file in a parent folder

3
votes

I have a github repository with a Github Page website activated structured as followed:

/
|__README.md
|__docs/
   |__ _config.yml
   |__ stylesheets
   |__ javascripts
   |__ images
   |__ index.md

The files docs/index.md and README.md are stricly identical. How could I set README.md file as the "index" file with Jekyll ? Or at least make index.md include README.md ?

I tried the following and it does not work:

# First try
{% include ../README.md %}

# Second attempt
{% include_relative ../README.md %}

For the record, I use the theme: jekyll-theme-architect

1
rubyjekyllgithub-pages

1 Answers

1
votes

You may set permalink by front matter in README.md to generate as index.html:

---
permalink: index.html
---