Skip to content

Commit

Permalink
Merge branch 'quarto-dev:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
statkclee authored May 26, 2024
2 parents db6eb62 + e1026cf commit 321ef05
Show file tree
Hide file tree
Showing 4,628 changed files with 981,465 additions and 247,900 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
5 changes: 3 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ src/resources/build/** linguist-vendored
src/resources/editor/tools/** linguist-vendored
src/vendor/** linguist-vendored
src/resources/vendor/** linguist-vendored

tests/docs/** linguist-vendored
src/resources/library/dayjs/** linguist-vendored

# use lf line-endings for source files
src/** text eol=lf
Expand All @@ -42,6 +43,6 @@ src/** text eol=lf
*.eot binary
*.wasm binary
*.bcmap binary

*.otf binary


2 changes: 2 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Examples of unacceptable behavior include:
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
* Providing bad information by copying output from AI assistants
without verifying its validity

## Enforcement Responsibilities

Expand Down
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ You can contribute in many ways:
- By submitting Pull Request (PR) to fix opened issues
- By submitting Pull Request (PR) to suggest new features (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).

## To submit a contribution using a Pull Request:
## To submit a contribution using a Pull Request

1. [Fork](https://github.com/quarto-dev/quarto-cli/fork) the repository, clone it locallly, and make your changes in a new branch specific to the PR. For example:
1. [Fork](https://github.com/quarto-dev/quarto-cli/fork) the repository, clone it locally, and make your changes in a new branch specific to the PR. For example:

```bash
# clone your fork
Expand All @@ -25,8 +25,8 @@ You can contribute in many ways:
$ git checkout -b bugfix/myfix
```

2. For significant changes (e.g not required for fixing typos), ensure that you have signed the [individual](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <[email protected]>.
2. For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <[email protected]>.

3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as a draft if you are still working on it but would like some feedback from us. It is always good to share in the open that you are working on it.

We'll try to be as responsive as possible in reviewing and accepting pull requests. Very much appreciate your contributions!
28 changes: 28 additions & 0 deletions .github/DISCUSSION_TEMPLATE/feature-requests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
title: "The (missing) feature you want to discuss"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
First, please check [Quarto Issues](https://github.com/quarto-dev/quarto-cli/issues) and [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests) to see if your feature request has already been discussed.
If it has, please consider adding a comment to the existing discussion instead of creating a new one.
After checking, if you are not sure if your feature request has already been discussed, please create a new discussion.
We look forward to hearing from you.
If you want to ask for help, please consider using the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a), as it is better suited for answering your question.
Finally, try to describe the best you can what you want to achieve and why you think it is important.
This will help us to understand your request and prioritise it.
_Thank you for opening this feature request!_
- type: textarea
attributes:
label: Description
description: Start your discussion!
validations:
required: true
- type: markdown
attributes:
value: |
_Thank you for opening this feature request!_
76 changes: 76 additions & 0 deletions .github/DISCUSSION_TEMPLATE/q-a.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
title: "Your question in one sentence (e.g., How do I preview documents with Quarto?)"
body:
- type: markdown
attributes:
value: |
First, please check [Quarto Issues](https://github.com/quarto-dev/quarto-cli/issues) and [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a) first to see if your question has already been asked.
If it has, please consider adding a comment to the existing discussion instead of creating a new one.
After checking, if you are not sure if your question has already been asked, please create a new discussion.
We look forward to hearing from you.
Finally, try to describe the best you can what you want to achieve or what is your issue, especially by providing a complete self-contained reproducible example (consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html)).
This will help us to understand your question and answer it.
`````md
````qmd
---
title: "Reproducible Quarto Document"
format: html
engine: jupyter
---
This is a reproducible Quarto document using `format: html`.
It is written in Markdown and contains embedded Python code.
When you run the code, it will produce a message.
```{python}
print("Hello, world!")
```
![A placeholder image](https://placehold.co/600x400.png)
The end.
````
`````
You can add some additional information that can help us to help you:
- What Quarto version are you using?
You can find the version of Quarto you used by running `quarto --version` in your terminal.
- What operating system are you using?
Linux Ubuntu 20.04, macOS 11.2.3, Windows 10, _etc._
_Thank you for opening this discussion either to ask for help or to report a possible bug!_
- type: textarea
attributes:
label: Description
description: Start your question/report!
placeholder: |
You can include Quarto document code which includes code blocks like this:
````qmd
---
title: "Hello Quarto!"
format: html
---
```py
print("Hello Quarto!")
```
````
---
### Additional information that can help us to help you
- What Quarto version are you using?
You can find the version of Quarto you used by running `quarto --version` in your terminal.
- What operating system are you using?
Linux Ubuntu 20.04, macOS 11.2.3, Windows 10, _etc._
validations:
required: true
- type: markdown
attributes:
value: |
_Thank you for opening this discussion either to ask for help or to report a possible bug!_
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/show-and-tell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
title: "The item you want to talk about"
body:
- type: markdown
attributes:
value: |
If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests).
If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a).
- type: textarea
attributes:
label: Description
description: Start your Quarto tale!
validations:
required: true
- type: markdown
attributes:
value: "_Thanks for using Quarto and talking about your use case!_"
90 changes: 68 additions & 22 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,86 @@
name: Bug report
description: Report an error or unexpected behavior you saw while using this package
description: Report an error or unexpected behavior
labels: [bug]

body:
- type: markdown
attributes:
value: |
Welcome to the quarto GitHub repo!
Welcome to the quarto GitHub repository!
We are always happy to hear feedback from our users.
Quarto is under active development! If possible, please confirm your issue persists on the [latest nightly release](https://github.com/quarto-dev/quarto-cli/releases).
To file a _bug report_, please follow these instructions carefully: <https://yihui.org/issue/#bug-reports>
Also, please complete and keep the checklist below in your issue. This helps you know what to check for opening a good issue report. It also helps know that you've have done the common steps that can solve your potential issue.
At last, if you have posted the same issue elsewhere, please mention it here, with a link to the other issue.
Quarto is under active development!
If convenient, we'd appreciate if you could check that the issue persists on the [latest pre-release](https://github.com/quarto-dev/quarto-cli/releases).
Finally, so that we can get the most out of your bug report, consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html).
If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests).
If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a).
Thank you for using Quarto!
- type: textarea
attributes:
label: Bug description
description: Please describe the bug.
description: Description of the bug.
placeholder: Please describe the bug here.

- type: textarea
attributes:
label: Steps to reproduce
description: |
Tell us how to reproduce this bug.
Please include a minimal, fully reproducible example as a self-contained Quarto document or a link to a Git repository.
placeholder: |
You can include markdown code blocks which includes code blocks like this:
You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `).
````qmd
---
title: "Reproducible Quarto Document"
format: html
---
````md
```py
print("Hello Quarto!")
This is a reproducible Quarto document using `format: html`.
It is written in Markdown and contains embedded R code.
When you run the code, it will produce a plot.
```{r}
plot(cars)
```
The end.
````
- type: checkboxes
- type: textarea
attributes:
label: Checklist
label: Expected behavior
description: Tell us what should happen.

- type: textarea
attributes:
label: Actual behavior
description: Tell us what happens instead.

- type: textarea
attributes:
label: Your environment
description: |
Please document the IDE (_e.g._ RStudio, VSCode, NVim), its version, and the operating system you're running (_e.g., MacOS Ventura 13.4, Windows 11, Linux Debian 11, _etc._).
placeholder: |
- IDE: RStudio 2023.03.1+446
- OS: MacOS Ventura 13.4
- type: textarea
attributes:
label: Quarto check output
description: |
When filing a _bug report_, please check the boxes below to confirm that you have provided us with the information we need. Have you:
options:
- label: "upgraded to the [latest nightly quarto version](https://github.com/quarto-dev/quarto-cli/releases)?"
- label: "[formatted your issue](https://yihui.org/issue/#please-format-your-issue-correctly) so it is easier for us to read?"
- label: included a minimal, fully reproducible example in a single .qmd file? Please provide the whole file rather than the snippet you believe is causing the issue.
- label: documented the RStudio IDE version you're running (if applicable), by providing the value displayed in the "About RStudio" main menu dialog?
- label: documented which operating system you're running? If on Linux, please provide the specific distribution as well.
Please provide the output of `quarto check` so we know which version of quarto and its dependencies you're running.
placeholder: |
```bash
quarto check
```
- type: markdown
attributes:
value: "_Thanks for submitting this bug report!_"
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Issue guide
url: https://quarto.org/bug-reports.html
about: First time here or need a refresh? Please consult the issue guide before posting.
- name: Ask a question
url: https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a
about: Please ask and answer questions in our Discussion board
- name: Share an idea, a missing feature or anything else
url: https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests
about: Please give us any feedback in our Discussion board
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Documentation issue
description: Report issues on quarto.org, give documentation feedback, or suggest documentation improvements
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Welcome to the quarto GitHub repository!
We are always happy to hear feedback from our users.
When reporting an issue with the documentation, please consider adding a link to the page you are referring to and a screenshot of the issue.
If you want to report a bug, please use the [Bug Reports GitHub Issues](https://github.com/quarto-dev/quarto-cli/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml).
If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests).
If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a).
Thank you for using Quarto!
- type: dropdown
id: type-documentation
attributes:
label: What would you like to do?
options:
- Report an issue on quarto.org
- Give feedback or suggest an improvement
default: 0
validations:
required: true

- type: textarea
attributes:
label: Description
description: Describe the issue, give feedback or suggest an improvement.
placeholder: Please describe your issue/feedback/improvement here. For issues on quarto.org, include a link to the page you are referring to and a screenshot of the issue.

- type: markdown
attributes:
value: "_Thanks for submitting this bug report, feedback or improvement suggestion!_"
33 changes: 33 additions & 0 deletions .github/actions/cache-typst/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Cache Typst package"
description: "Configures the caching for Typst packages"

runs:
using: "composite"
steps:
- name: Typst Cache path
run: |
case $RUNNER_OS in
"Linux")
echo "TYPST_CACHE=${XDG_CACHE_HOME:-~/.cache}/typst/packages/" >> $GITHUB_ENV
;;
"macOS")
echo "TYPST_CACHE=~/Library/Caches/typst/packages/" >> $GITHUB_ENV
;;
"Windows")
echo "TYPST_CACHE=$LOCALAPPDATA/typst/packages/" >> $GITHUB_ENV
;;
*)
echo "$RUNNER_OS not supported"
exit 1
;;
esac
shell: bash

- name: Cache Typst package folder
uses: actions/cache@v4
with:
path: ${{ env.TYPST_CACHE }}
key: ${{ runner.os }}-typst-1-${{ github.run_id }}
restore-keys: |
${{ runner.os }}-typst-1-
save-always: true
Loading

0 comments on commit 321ef05

Please sign in to comment.