search

just-the-docs / just-the-docs-template

one-click template to use just-the-docs on GitHub Pages
https://just-the-docs.github.io/just-the-docs-template/
MIT License
128 stars 109 forks source link

bug : I feel the `jekyll-default-layout` should be auto included in the #56

Open tu2-atmanand opened 2 days ago

tu2-atmanand commented 2 days ago

Hii, first of all, thank you so much for the amazing theme project and for this template!

The issue I faced, after I setup the theme perfectly for my repo is, everything worked fine, except the theme didnt got applied to all the markdown files. It only was applied to the index.md in docs/ folder, since i put the layout: default front matter property for this file.

After some surfing, I figured out about the gem files, plugin inside the _config.yml file, etc. Then realized, the jekyll-default-layout is a required plugin for the theme to be applied to all the files/pages.

So, I feel, it should be already configured inside the _config.yml file, instead of user to figure it out and put it themselves.

Let me know, if that was the case, or I did something wrong.

tu2-atmanand commented 2 days ago

Another suggestion

During the surfing and from my last theme, I found out that, we can use the jekyll-relative-links plugin, to make the adding of links much easier. Since, I am writing the docs from VS Code, adding links and then navigating to different pages is very easy using the markdown viewer plugin. So, I use to use, the following method to add internal links from a long time : 

[Types of Columns](../Features/Types_Of_Columns.md)

But, if we are not using the plugin, we will have to use the following way of adding internal links, which is much painstaking process and I dont know if there is any plugin in VS Code for this to make adding links like the following easier. (Also, not to mention, the following way of adding internal links wont work, if the user is surfing the pages from GitHub repo) : 

[Types of Columns]({% link docs/Features/Types_Of_Columns.md %})