Create alternative syntax for frontmatter #2145
Merged
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
jovyntls
previously requested changes
Feb 23, 2023
There was a problem hiding this comment.
Thank you for the work @EltonGohJH - nice catching all the edge cases of the markdown parsing!
The --- frontmatter works for me and is a nice feature addition 🎉
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
EltonGohJH
force-pushed
the
elton-alt-frontmatter
branch
from
812375e to
70c8eed
Compare
jovyntls
reviewed
Feb 26, 2023
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
EltonGohJH
force-pushed
the
elton-alt-frontmatter
branch
from
40d1ac4 to
80c8f1d
Compare
tlylt
reviewed
Mar 31, 2023
packages/core/src/lib/markdown-it/plugins/markdown-it-alt-frontmatter.js
Outdated
Show resolved
Hide resolved
EltonGohJH
changed the title
|
I did some double checking to ensure that the converted html is equivalent to what our current frontmatter.
|
|
LGTM after:
|
|
Negative testcases |
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.
What is the purpose of this pull request?
Overview of changes:
Resolves #1851
Anything you'd like to highlight/discuss:
As dicussed previously, I have added regex to check in between the new frontmatter index. Can someone do a sanity check that my markdown-it plugin is correct. If all is good, I will go create new test cases and add new docs.
I tested this with CS2103T website with 700 over pages and it took around the same time of 2mins 6 seconds. So, this test on my end concluded that performance is not visibly affected at all.
Proposed commit message: (wrap lines at 72 characters)
Checklist: ☑️