Danielbrzn add frontmatter #5
Open
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
- siteData.json will eventually contain all front-matter data from pages which are addressable. It will also be used as the search index.
- Modify parser to only parse body of .md files instead of the whole file
- Add constants to improve readability of code - Allow for include within <frontmatter> tags - Add src attribute for addressable pages without specified titles
- The test site has been updated to use the frontmatter feature and thus the expectedSite has to be updated to match the new format of the site.
- Frontmatter data has already been collated in siteData.json and there's no reason to render it with the page's content
- Search will now use the collated siteData as an index as it now contains the keywords and titles for queries to be matched against - Update the compiled vue js file. It includes the changes made to search in order for it to use the front matter data
- siteData.json will contain all front-matter data from pages which are addressable. It will also be used as the search index.
- Modify parser to only parse body of .md files instead of the whole file
- Add constants to improve readability of code - Allow for include within <frontmatter> tags - Add src attribute for addressable pages without specified titles
- The test site has been updated to use the frontmatter feature and thus the expectedSite has to be updated to match the new format of the site.
- Previously all JSON files were ignored, but siteData.json should not be ignored as it serves as the index for front matter search.
- The site index is now properly rebuilt whenever there is a change made to a page's front matter data
- Add ability to use Typeahead.vue to search objects instead of having to use a separate Vue component
- To preserve compatibility with older Markbind sites, globs are supported in the pages array of site.json
- Update expected site to ensure tests pass
- Remove promisified collectFrontMatter function as there are no async functions within - Remove unneeded constants from Page.js - Add a writeSiteData function for clearer code - Rename buildIndex to collectAddressablePaths to better reflect the function's activity - Change how siteData.json is fetched for the search feature
- Add documentation for front matter and site.json changes
- This ensures that the siteData generated matches the expected in the test site
- Add comments to front matter collection logic - Separate removal logic from collection logic as dynamically included pages need only have their front matter removed
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.
No description provided.