aksakalli / jekyll-doc-theme

Jekyll theme for creating project documentation websites
https://aksakalli.github.io/jekyll-doc-theme/
MIT License
288 stars 261 forks source link

Updated asset/pages and scss files #39

Closed kenjdavidson closed 4 years ago

kenjdavidson commented 5 years ago

Resolution for issue #37

kenjdavidson commented 5 years ago

Also updated the footer style so that when the footer becomes two lines, it's displayed properly where the background reaches the bottom of the window.

aksakalli commented 5 years ago

Thank you. I think it is not so intuitive to see page sources inside assets. Alternatively, we can put the rendering logic to _layouts and have an empty page in the root? Like this theme:

Also, it would be nice to include the documentation, how to install it as an remote theme. What do you think?

kenjdavidson commented 5 years ago

It's your show, but in all honesty after going through the Remote-Theme and the Jekyll code, it looks like this was the design when they moved to the /asset directory. The function called is actually LoadThemeAssets and not just LoadAssets.

If you relate this specifically to this project, you would have:

this will still not build the allposts.html file from the theme, the user of the theme will still need to copy the ./allposts.md file from the project, to their own project. I think as long as it's documented that the assets folder contains the three pages (and maybe more in the future) that the person implementing the theme doesn't need to do anything.

In the project I'm using your theme it's working perfectly. I don't need to think about it, and if you updated the ./assets/allposts.md with anything, I just need to rebuild, I don't need to recopy ./allposts.md to my project again. I also have the ability to override my own ./asset/allposts.md if I do want it to change.

All in all, obviously it's your show (and I'm just one guy), but after going through the code and seeing what they had actually called the assets folder, it makes sense.