Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options and parts to frontmatter #736

Merged
merged 21 commits into from
Nov 14, 2023
Merged

Add options and parts to frontmatter #736

merged 21 commits into from
Nov 14, 2023

Conversation

fwkoch
Copy link
Collaborator

@fwkoch fwkoch commented Nov 9, 2023

  • options are template options for site config or page/project frontmatter; this (1) allows options to be provided in a centralized place, rather than on each export, and (2) gives an explicit place for these arbitrary options to be found
    • TODO: tidy up warning messages for unused options, now that options may apply to different exports, so they may be unused on one place but used in another.
  • parts are document parts, previously only defined with block metadata part: 'abstract', now you can put the abstract directly in the frontmatter. It is then inserted into the document as a hidden block, and transformed with the rest of the content.

Copy link
Member

@rowanc1 rowanc1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments!

packages/myst-config/src/site/types.ts Show resolved Hide resolved
packages/myst-to-jats/src/types.ts Outdated Show resolved Hide resolved
@rowanc1
Copy link
Member

rowanc1 commented Nov 9, 2023

I think merging #741 would be good. We need to by default turn the extracted abstracts, etc. to visible.

@rowanc1
Copy link
Member

rowanc1 commented Nov 9, 2023

Have tested parts and that works great! Still need to test out options.

@stevejpurves
Copy link
Contributor

@fwkoch do you have an example myst.yml file that you can post here showing the layout of parts and options after this PR?

@rowanc1 rowanc1 merged commit b127d5e into main Nov 14, 2023
4 checks passed
@rowanc1 rowanc1 deleted the feat/parts-options branch November 14, 2023 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants