Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tu2-atmanand opened this issue Nov 6, 2024 · 2 comments

Comments

@tu2-atmanand
Copy link

tu2-atmanand commented Nov 6, 2024

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
Copy link
Author

tu2-atmanand commented Nov 6, 2024

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 %})

@markwkidd
Copy link

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 %})

I have submitted a PR which I believe will help indicate how to configure a github / github pages deployment to work correctly with Jekyll's relative URL parsing. Here is my work on that: #57

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants