Skip to content

Commit 100b913

Browse files
authored
Merge pull request #10074 from mcanouil/docs/issue-discussion-examples
docs: Improve issue/discussion templates
2 parents f9e0907 + dc3bfcb commit 100b913

2 files changed

Lines changed: 68 additions & 9 deletions

File tree

.github/DISCUSSION_TEMPLATE/q-a.yml

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ body:
2828
print("Hello, world!")
2929
```
3030
31-
![A placeholder image](https://placehold.co/600x400.png)
31+
![An image]({{< placeholder 600 400 >}}){#fig-placeholder}
32+
33+
{{< lipsum 1 >}}
34+
35+
A reference to @fig-placeholder.
3236
3337
The end.
3438
````
@@ -49,16 +53,31 @@ body:
4953
placeholder: |
5054
You can include Quarto document code which includes code blocks like this:
5155
56+
`````md
5257
````qmd
5358
---
54-
title: "Hello Quarto!"
59+
title: "Reproducible Quarto Document"
5560
format: html
61+
engine: jupyter
5662
---
5763
58-
```py
59-
print("Hello Quarto!")
64+
This is a reproducible Quarto document using `format: html`.
65+
It is written in Markdown and contains embedded Python code.
66+
When you run the code, it will produce a message.
67+
68+
```{python}
69+
print("Hello, world!")
6070
```
71+
72+
![An image]({{< placeholder 600 400 >}}){#fig-placeholder}
73+
74+
{{< lipsum 1 >}}
75+
76+
A reference to @fig-placeholder.
77+
78+
The end.
6179
````
80+
`````
6281
6382
---
6483

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
We are always happy to hear feedback from our users.
1111
1212
This is the repository for the command-line program `quarto`:
13-
13+
1414
- If you're reporting an issue with the VS Code extension, please visit https://github.com/quarto-dev/quarto
1515
- If you're reporting an issue inside RStudio, please visit https://github.com/rstudio/rstudio
1616
@@ -24,6 +24,37 @@ body:
2424
2525
Thank you for using Quarto!
2626
27+
---
28+
29+
You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `).
30+
For example with Quarto CLI >=1.5:
31+
32+
`````md
33+
````qmd
34+
---
35+
title: "Reproducible Quarto Document"
36+
format: html
37+
engine: jupyter
38+
---
39+
40+
This is a reproducible Quarto document using `format: html`.
41+
It is written in Markdown and contains embedded Python code.
42+
When you run the code, it will produce a message.
43+
44+
```{python}
45+
print("Hello, world!")
46+
```
47+
48+
![An image]({{< placeholder 600 400 >}}){#fig-placeholder}
49+
50+
{{< lipsum 1 >}}
51+
52+
A reference to @fig-placeholder.
53+
54+
The end.
55+
````
56+
`````
57+
2758
- type: textarea
2859
attributes:
2960
label: Bug description
@@ -39,22 +70,31 @@ body:
3970
placeholder: |
4071
You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `).
4172
73+
`````md
4274
````qmd
4375
---
4476
title: "Reproducible Quarto Document"
4577
format: html
78+
engine: jupyter
4679
---
4780
4881
This is a reproducible Quarto document using `format: html`.
49-
It is written in Markdown and contains embedded R code.
50-
When you run the code, it will produce a plot.
82+
It is written in Markdown and contains embedded Python code.
83+
When you run the code, it will produce a message.
5184
52-
```{r}
53-
plot(cars)
85+
```{python}
86+
print("Hello, world!")
5487
```
5588
89+
![An image]({{< placeholder 600 400 >}}){#fig-placeholder}
90+
91+
{{< lipsum 1 >}}
92+
93+
A reference to @fig-placeholder.
94+
5695
The end.
5796
````
97+
`````
5898
5999
- type: textarea
60100
attributes:

0 commit comments

Comments
 (0)