masasam / emacs-easy-hugo

Emacs major mode for managing hugo
https://gohugo.io/tools/editors/#emacs
GNU General Public License v3.0
362 stars 26 forks source link

Doc/readme-updates #77

Closed ttybitnik closed 1 year ago

ttybitnik commented 1 year ago

Hey there @masasam,

While revisiting the package and Hugo documentation to find a way to implement featured post images, I came up with some README modifications listed at the end.

Rather than introducing an images field into the org template, as we did for categories in #73, which was a good default, I wrote a brief explanation on how to include custom front matter fields/keywords for easy-hugo-org-header users, based on Front Matter docs. I think this approach makes more sense this time since the images field wouldn't be a sane default for the template, due its narrow use case and its dissonance from other templates fields in the repo.

The easy-hugo-list-draft is working fine with the easy-hugo-org-header set, so I removed a statement on that. Optionally, I also did some changes in the intro of the README, centering the logo and restructuring the synopsis---not sure if these were desired, so feel free to edit or drop them completely.

TLDR:

(My very first PR on GitHub was on this repo and you kindly welcomed it even though I was a newcomer. That encouraged me to learn more and contribute to open-source projects that I use. So thank you for your time and dedication to this package. I was happy to see it featured in the Hugo documentation.)

ttybitnik commented 1 year ago

Well, not sure if I like the logo centered anymore hahaha ¯_(ツ)_/¯

(Let me know and I revert it if you want)

masasam commented 1 year ago

Hi @ttybitnik ! Thank you for PR! I'm also happy to be included in hugo's documentation. Please continue to help open source.