fix: 🐛 only remove qmd files in reference post render to fix md formatting issues #1107
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
Removing the entire `reference/` folder post-render is problematic because the `_sidebar.yml` file in this folder is referenced under `metadata-files` in `_quarto.yml`. When this file is removed post-render, it seems to disrupt Quarto's functionality in VS Code, affecting its visual mode. As a result, formatting (including column wrapping at length 72) doesn't work as expected. Changing the post-render process to remove only `qmd` files resolves this issue, since (as far as I understand) preserving `_sidebar.yml` ensures `_quarto.yml` remains valid and maintains an uninterrupted visual mode
martonvago
approved these changes
Mar 5, 2025
lwjohnst86
approved these changes
Mar 5, 2025
lwjohnst86
deleted the
fix/markdown-not-formatting-in-quartos-visual-mode
branch
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.
Description
Removing the entire
reference/folder post-render is problematic because the_sidebar.ymlfile in this folder is referenced undermetadata-filesin_quarto.yml. When this file is removed post-render, it seems to disrupt Quarto's functionality in VS Code, affecting its visual mode. As a result, formatting (including column wrapping at length 72) doesn't work as expected.Changing the post-render process to remove only
qmdfiles resolves this issue, since (as far as I understand) preserving_sidebar.ymlensures that_quarto.ymlremains valid and maintains an uninterrupted visual mode.Please check if this works for you locally by:
just build-website(to get the_sidebar.ymlback)mdor aqmdfile, go to visual mode, save it, and go back to source mode.Is the formatting still OK after these steps for you as well? 🤞
Closes #1089