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.

Sign up for GitHub

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

Add Quarto Space docs #1226

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+66 −0
Open

Add Quarto Space docs #1226

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c972ff7
Add Quarto Space docs
Feb 27, 2024
f07cc46
Apply suggestions from code review
Mar 6, 2024
03daac3
Reorganize TOC
Mar 6, 2024
a354a3d
Break documentation into three sections
Mar 6, 2024
4c6060b
Apply suggestions from code review
Mar 7, 2024
c5fa185
Further code review
Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/hub/_toctree.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@
title: Livebook on Spaces
- local: spaces-sdks-docker-shiny
title: Shiny on Spaces
- local: spaces-sdks-docker-quarto
title: Quarto on Spaces
gshotwell marked this conversation as resolved.
Show resolved Hide resolved
- local: spaces-sdks-docker-zenml
title: ZenML on Spaces
- local: spaces-sdks-docker-panel
Expand Down
24 changes: 24 additions & 0 deletions docs/hub/spaces-sdks-docker-quarto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Quarto on Spaces

Quarto is a powerful tool for creating reproducible scientific and technical documents.
gshotwell marked this conversation as resolved.
Show resolved Hide resolved
With Quarto you can interleave markdown and code chunks to generate pdfs, websites, presentations and more.
gshotwell marked this conversation as resolved.
Show resolved Hide resolved

### Getting Started with Quarto on Spaces

1. Create the Quarto space, and clone it locally

<a href="https://huggingface.co/new-space?template=posit/quarto-template"> <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-lg.svg"/> </a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split this into two steps, and I think you should add an example code snippet on how to clone the repo

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, cloning locally is not a strict requirement no? People can do the development entirely in the UI. I would suggest to split this into

  • Creating and setting up the repo, doing changes in the Space by directly modifying /src
  • Developing locally (install quarto, VS Code extension)
  • Learn more about Quarto

Copy link
Contributor Author

@gshotwell gshotwell Mar 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose that's true, but working on a quarto site in the browser without being able to preview the site would likely be pretty awkward. Happy to change the organization though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think mentioning, even if briefly, the in-browser setup could be ok!

gshotwell marked this conversation as resolved.
Show resolved Hide resolved

2. **Install Quarto**: In order to render your Quarto site without Docker, we recommend installing Quarto by following the instructions on the [official Quarto website](https://quarto.org/docs/get-started/).

3. **Install Quarto VS Code extension** the [Quarto VS Code Extention](https://quarto.org/docs/tools/vscode.html) includes a number of productivity tools including YAML Autocomplete, a preview button, and a visual editor. Quarto works great with VS Code, but the extension does make it easier to get the most out of Quarto.
gshotwell marked this conversation as resolved.
Show resolved Hide resolved

4. **Edit the site** The website files are contained in the `src` directory, and the site navigation is defined in `src/_quarto.yml`, try editing these files and either clicking the "Preview" button in VS Code, or calling `quarto preview src` from the command line.
gshotwell marked this conversation as resolved.
Show resolved Hide resolved

5. **Learn more about Quarto** You can do a lot of things with Quarto, and they are all documented on the [Quarto Website](https://quarto.org/guide/). In particular you may be interested in:
gshotwell marked this conversation as resolved.
Show resolved Hide resolved

- All about building [websites](https://quarto.org/docs/websites/)
- Building Static [Dashboards](https://quarto.org/docs/dashboards/)
- How to write [books](https://quarto.org/docs/books/index.html) and [manuscripts](https://quarto.org/docs/manuscripts/)
- Reproducible [presentations](https://quarto.org/docs/manuscripts/)
- Including [Observable](https://quarto.org/docs/interactive/ojs/) or [Shiny](https://quarto.org/docs/interactive/shiny/) applications in your Quarto site
Loading