(MAINT) Initial publishing of FrontMatter configs #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change extends the functionality of memo for documenting a hugo theme to enable a theme author to publish [FrontMatter][01] config files, which users can then reference in their own projects instead of having to find and copy all the values. In this basic implementation: - An author can define `memo.front_matter.configs` in their site params or on a particular page to publish one or more configurations. The implementation requires that the configurations be defined as assets. The implementation allows you to specify the config path as a remote asset, a site asset, or a page asset and resolves the config path to the appropriate asset. Authors can define either the `definition` or `merge` key in an item but not both. Items with the `definition` key publish a single config and have the option to specify the site-relative publish path with the `publish` key. Items with the `merge` key merge the values from multiple configs to publish as a merged blob to the site-relative path defined by the mandatory `publish` key. - Memo has been updated to take advantage of the merge-from-data feature in Platen to allow setting the site parameters in a data file. - The new configuration options are validated before use, warning and discarding invalid values.
✅ Deploy Preview for platen ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
This change takes advantage of the improvements to the memo module to publish an initial group of configs for FrontMatter users. This initial pass doesn't do any further work with the documentation, it just makes the composed configurations available for testing. This is in support of estruyf/vscode-front-matter#407, which adds the `frontMatter.extends` key.
michaeltlombardi
force-pushed
the
maint/main/publish-front-matter-configs
branch
from
31fcbd7
to
d827e71
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change extends the functionality of memo for documenting a hugo theme to enable a theme author to publish [FrontMatter][01] config files, which users can then reference in their own projects instead of having to find and copy all the values.
This change is in support of estruyf/vscode-front-matter#407, which adds the
frontMatter.extendskey.In this basic implementation:
An author can define
memo.front_matter.configsin their site params or on a particular page to publish one or more configurations.The implementation requires that the configurations be defined as assets. The implementation allows you to specify the config path as a remote asset, a site asset, or a page asset and resolves the config path to the appropriate asset.
Authors can define either the
definitionormergekey in an item but not both. Items with thedefinitionkey publish a single config and have the option to specify the site-relative publish path with thepublishkey. Items with themergekey merge the values from multiple configs to publish as a merged blob to the site-relative path defined by the mandatorypublishkey.Memo has been updated to take advantage of the merge-from-data feature in Platen to allow setting the site parameters in a data file.
The new configuration options are validated before use, warning and discarding invalid values.