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

Jump to bottom

fix(schema/definitions.yml): Giscus light/dark theme YAML key is missing #10005

Merged
merged 2 commits into from
Jun 14, 2024
Merged

fix(schema/definitions.yml): Giscus light/dark theme YAML key is missing #10005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f48e78
fix: Giscus light/dark theme yaml example incorrect
mcanouil Jun 14, 2024
98b9b52
chore: update changelog
mcanouil Jun 14, 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
1 change: 1 addition & 0 deletions news/changelog-1.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,3 +228,4 @@ All changes included in 1.5:
- `quarto install tinytex` will now try to set the default CTAN repository to the nearest mirror resolved from https://mirror.ctan.org.
- `quarto render --to native` now works without triggering rmarkdown error about non HTML output when HTML dependencies are present in the knitr engine cell results.
- Missing `tabsets` configuration for HTML documents has now been added in the YAML schema for validation and autocompletion. This boolean value controls the inclusion of tabsets in the document (e.g when `minimal: true` is set).
- ([#10003](https://github.com/quarto-dev/quarto-cli/issues/10003)): fix Giscus light/dark theme YAML example in schema where `theme` is missing.
12 changes: 6 additions & 6 deletions src/resources/editor/tools/vs-code.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8751,7 +8751,7 @@ var require_yaml_intelligence_resources = __commonJS({
],
description: {
short: "The giscus theme to use when displaying comments.",
long: "The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: \n\n```yaml\nwebsite:\n comments:\n giscus:\n light: light # giscus theme used for light website theme\n dark: dark_dimmed # giscus theme used for dark website theme\n```\n"
long: "The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: \n\n```yaml\nwebsite:\n comments:\n giscus:\n theme:\n light: light # giscus theme used for light website theme\n dark: dark_dimmed # giscus theme used for dark website theme\n```\n"
}
},
language: {
Expand Down Expand Up @@ -21755,6 +21755,7 @@ var require_yaml_intelligence_resources = __commonJS({
"Enables inclusion of Pandoc default CSS for this document.",
"One or more CSS style sheets.",
"Enables hover over a section title to see an anchor link.",
"Enables tabsets to present content.",
"Enables smooth scrolling within the page.",
{
short: "Method use to render math in HTML output",
Expand Down Expand Up @@ -22826,8 +22827,7 @@ var require_yaml_intelligence_resources = __commonJS({
},
"Disambiguating year suffix in author-date styles (e.g. \u201Ca\u201D in \u201CDoe,\n1999a\u201D).",
"Manuscript configuration",
"internal-schema-hack",
"Enables tabsets to present content."
"internal-schema-hack"
],
"schema/external-schemas.yml": [
{
Expand Down Expand Up @@ -23056,12 +23056,12 @@ var require_yaml_intelligence_resources = __commonJS({
mermaid: "%%"
},
"handlers/mermaid/schema.yml": {
_internalId: 186347,
_internalId: 186493,
type: "object",
description: "be an object",
properties: {
"mermaid-format": {
_internalId: 186339,
_internalId: 186485,
type: "enum",
enum: [
"png",
Expand All @@ -23077,7 +23077,7 @@ var require_yaml_intelligence_resources = __commonJS({
exhaustiveCompletions: true
},
theme: {
_internalId: 186346,
_internalId: 186492,
type: "anyOf",
anyOf: [
{
Expand Down
12 changes: 6 additions & 6 deletions src/resources/editor/tools/yaml/web-worker.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions src/resources/editor/tools/yaml/yaml-intelligence-resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1723,7 +1723,7 @@
],
"description": {
"short": "The giscus theme to use when displaying comments.",
"long": "The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: \n\n```yaml\nwebsite:\n comments:\n giscus:\n light: light # giscus theme used for light website theme\n dark: dark_dimmed # giscus theme used for dark website theme\n```\n"
"long": "The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: \n\n```yaml\nwebsite:\n comments:\n giscus:\n theme:\n light: light # giscus theme used for light website theme\n dark: dark_dimmed # giscus theme used for dark website theme\n```\n"
}
},
"language": {
Expand Down Expand Up @@ -14727,6 +14727,7 @@
"Enables inclusion of Pandoc default CSS for this document.",
"One or more CSS style sheets.",
"Enables hover over a section title to see an anchor link.",
"Enables tabsets to present content.",
"Enables smooth scrolling within the page.",
{
"short": "Method use to render math in HTML output",
Expand Down Expand Up @@ -15798,8 +15799,7 @@
},
"Disambiguating year suffix in author-date styles (e.g. “a” in “Doe,\n1999a”).",
"Manuscript configuration",
"internal-schema-hack",
"Enables tabsets to present content."
"internal-schema-hack"
],
"schema/external-schemas.yml": [
{
Expand Down Expand Up @@ -16028,12 +16028,12 @@
"mermaid": "%%"
},
"handlers/mermaid/schema.yml": {
"_internalId": 186347,
"_internalId": 186493,
"type": "object",
"description": "be an object",
"properties": {
"mermaid-format": {
"_internalId": 186339,
"_internalId": 186485,
"type": "enum",
"enum": [
"png",
Expand All @@ -16049,7 +16049,7 @@
"exhaustiveCompletions": true
},
"theme": {
"_internalId": 186346,
"_internalId": 186492,
"type": "anyOf",
"anyOf": [
{
Expand Down
11 changes: 6 additions & 5 deletions src/resources/schema/definitions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,9 @@
website:
comments:
giscus:
light: light # giscus theme used for light website theme
dark: dark_dimmed # giscus theme used for dark website theme
theme:
light: light # giscus theme used for light website theme
dark: dark_dimmed # giscus theme used for dark website theme
```
language:
string:
Expand Down Expand Up @@ -750,15 +751,15 @@
description: "Whether this announcement may be dismissed by the user."
icon:
schema: string
description:
description:
short: "The icon to display in the announcement"
long: |
Name of bootstrap icon (e.g. `github`, `twitter`, `share`) for the announcement.
See <https://icons.getbootstrap.com/> for a list of available icons
position:
schema:
enum: ["above-navbar", "below-navbar"]
description:
description:
short: "The position of the announcement."
long: |
The position of the announcement. One of `above-navbar` (default) or `below-navbar`.
Expand All @@ -775,7 +776,7 @@
light,
dark,
]
description:
description:
short: "The type of announcement. Affects the appearance of the announcement."
long: |
The type of announcement. One of `primary`, `secondary`, `success`, `danger`, `warning`,
Expand Down
5 changes: 3 additions & 2 deletions src/resources/types/schema-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,9 @@ the discussions feature must be enabled. */;
website:
comments:
giscus:
light: light # giscus theme used for light website theme
dark: dark_dimmed # giscus theme used for dark website theme
theme:
light: light # giscus theme used for light website theme
dark: dark_dimmed # giscus theme used for dark website theme
``` */
};
hypothesis?: boolean | {
Expand Down
Loading