search

GetRD / academic-file-converter

📚 Import Bibtex publications and Jupyter Notebook blog posts into your Markdown website or book. 将Bibtex转换为Markdown网站
https://docs.hugoblox.com/reference/content-types/#automatically-import-publications-from-bibtex
MIT License
363 stars 102 forks source link

Migrate config/params TOML to YAML #86

Closed jmuchovej closed 3 years ago

jmuchovej commented 4 years ago

This may not belong here, but I've found myself having to manually diff changes between config.toml and params.toml between Wowchemy versions.

I'm not sure what the failure modes might be, but adding new config/params options anytime those new changes are made would be good, I think?

The use of migrating from TOML to YAML is that ruamel.yaml supports round-trip comments. I don't believe the toml pypi package supports that.

gcushen commented 4 years ago

It's interesting that you mentioned this.

We use YAML for some internal config.yaml files, such as for the Test site at https://github.com/wowchemy/wowchemy-hugo-modules/blob/master/wowchemy/test/config.yaml , primarily to keep things simpler so both front matter and config are in YAML. We have been converting the remaining TOML front matter in templates to YAML as GitHub still does not support TOML (even though TOML was created by and named after Tom, the founder of GitHub). We could convert the config dirs in the templates too, but it would require a lot of changes to the docs/release-notes and may cause some confusion.

We have worked on some ideas for an upgrader tool in the past. If we were to create a new repo for such a tool, we would probably use either Go (to avoid any client dependencies and align with Hugo) or JS (to create a web-based tool, similar in some respects to how Hugo Server spawns a browser window). Would you be interested in contributing to such a project?

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had any recent activity. The resources of the Academic team are limited, and so we are asking for your help. If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open. If this is a feature request, and you feel that it is still relevant and valuable, please tell us why. This issue will automatically close soon if no further activity occurs. Thank you for your contributions.