quarto-dev / quarto-dev/quarto-cli

Pre render for quarto preview

Open
#4,841 1 comment 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement preview project-scripts
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

Discussed in https://github.com/quarto-dev/quarto-cli/discussions/4822

Originally posted by itepifanio March 14, 2023
Quarto provides pre and post rendering features but it doesn't extend when live previewing the documents.

I have a script that reads yaml content and outputs .qmd files used in a Quarto website. I was trying to add a custom watcher for the yaml files, this way, when a yaml file changes the .qmd files the Quarto live previewing would refresh.

My solution was running Quarto as a subprocess and creating the custom watcher. A pre rendering that works with live previewing would make my life easier because I would be able to run the yaml watcher script without working with subprocessing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Quarto preview path and how pre-render scripts and file watchers are currently handled. Verify the behavior described in the issue: pre-rendering should run during live preview, and changes to watched YAML files should refresh the generated .qmd files and preview without requiring a subprocess.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.