Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to explain how to test in Quarto #139

Open
gadenbuie opened this issue Jun 13, 2024 · 1 comment
Open

Update docs to explain how to test in Quarto #139

gadenbuie opened this issue Jun 13, 2024 · 1 comment

Comments

@gadenbuie
Copy link
Contributor

The README describes two make targets -- make quarto and make quartoserve -- that would, in theory, be used to test in-dev shinylive in Quarto.

These targets appear to be vestigal: the quarto/ directory was removed some time ago. Because this repo is tightly coupled with the quarto shinylive extension (at least in the sense that some issues that appear in the extension are solved here in this repo), it would be helpful to update the instructions to describe how to test in-dev shinylive in Quarto.

@gadenbuie
Copy link
Contributor Author

Here's what worked for me:

Setup local dev:

make clean
make submodules
make all

Then create a new document for testing

mkdir -p _dev/my-test/
touch _dev/my-test/test.qmd
touch _dev/my-test/_quarto.yml

Then set up a new venv for this document

cd _dev/my-test
# deactivate (if any venvs are currently active)

# start a new venv
uv venv
. .venv/bin/activate

# install py-shinylive in this new venv
uv pip install shinylive

# Link the shinylive in the newly activated venv to the dev build
shinylive assets link-from-local ../../build

# Preview the quarto doc
quarto preview test.qmd

In a separate terminal, watch and rebuild the assets as you work

make watch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant