Add ability to download raw "data files" used to build documentation #1353
Conversation
This file contains hidden or 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
It only took a year, but finally figured out that vite provides a plugin/hook (configResolved()) that allows us to execute code AFTER the configuration has been fully parsed and BEFORE the page transformations start. This is the correct place to force full loading of the various data files, since they need to pre-scan all the files for, e.g., frontmatter data needed to do proper inter-page linking. This allows us to use core javascript async/await functionality, rather than the somewhat hackish previous method of using "import-sync" module.
This comment has been minimized.
This comment has been minimized.
slusarz
force-pushed
the
data_parsing_refactor
branch
from
52d1338 to
a381519
Compare
This comment has been minimized.
This comment has been minimized.
…umentation Providing static versions of the fully parsed/transformed data files used to build the documentation may be useful, since it allows things like, e.g., parsing the settings or doveadm config files for use in automated coding and tasks.
slusarz
force-pushed
the
data_parsing_refactor
branch
from
6fe134c to
fe13c5d
Compare
There's ~4000 empty keys, so just need to refactor a few locations to ignore missing keys and we can substantially reduce the size of the chunk.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Providing static versions of the fully parsed/transformed data files used to build the documentation may be useful, since it allows things like, e.g., parsing the settings or doveadm config files for use in automated coding and tasks.
To get to this point, needed to refactor the data file parsing code to allow for these files to be generated at the appropriate points to be added to the build process.
Side effect: this allowed us (me) to finally fix the bootstrapping problem with the data files. We need to do a pre-scan of all files before beginning the actual transformation, since we need to build various lookup tables (e.g. links, settings) in order to replace markdown tokens. This was fixed by taking advantage of the vite "configResolved" plugin hook, which is the appropriate place to do this initialization.