McShelby / hugo-theme-relearn

A theme for Hugo designed for documentation
https://mcshelby.github.io/hugo-theme-relearn/
MIT License
426 stars 186 forks source link

frontmatter: move frontmatter config for exampleSite out of root #843

Closed darren-oxford closed 6 months ago

darren-oxford commented 6 months ago

Please don't include frontmatter.json in the theme, it results in front matter being incorrectly configured.

It creates a front matter configuration that has an example site and paths to windows executable that of course does not work on Linux or Mac.

McShelby commented 6 months ago

Thanks for the input.

Would it work for you, if the frontmatter.json is moved inside the exampleSite directory?

darren-oxford commented 6 months ago

Thanks for the quick reply, I have done a quick test and yes, moving the frontmatter.json file to the exampleSite directory prevented VSCode from picking it up when including the theme. I was then able to open the FrontMatter dashboard and initialize the project as expected.

You may also want to add the .frontmatter directory to your .gitignore.

Thanks for the great theme.

McShelby commented 6 months ago

Done. Thanks for the input.