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

YAML front matter #5

Open
kemayo opened this issue Dec 3, 2023 · 1 comment
Open

YAML front matter #5

kemayo opened this issue Dec 3, 2023 · 1 comment

Comments

@kemayo
Copy link

kemayo commented Dec 3, 2023

There's already a fairly common metadata system for markdown files, and it's YAML front-matter. Adding a second block of metadata at the end of the document seems less ideal, compared to just incorporating it into the existing common usage.

I'd speculate that the spec chose for annotations to be appended to the end because it means that when editing the annotated text you wouldn't get stuck in a recursive loop of changing the annotation-data changing the offsets that need to be recorded within the annotation-data. Fortunately there's a simple solution to this: specify that all character-ranges are given relative to the end of the front-matter.

@kemayo
Copy link
Author

kemayo commented Dec 3, 2023

The drawback to specifying that character ranges are relative to the front-matter's end would, of course, be that it'd not be possible to annotate the content within the front-matter. That's a trade-off that doesn't seem too bad to me.

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

No branches or pull requests

1 participant