Skip to content

docs: update description for brand typography "files" field #12268

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

Draft
mcanouil wants to merge 4 commits into
base: main
Choose a base branch
from
+3 −2
Draft

docs: update description for brand typography "files" field #12268

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6302ce
docs: add expected schema for brand typography "files" field
mcanouil Mar 12, 2025
43f93e1
fix: use "`- path: <path>` or `- <path>`"
mcanouil Mar 12, 2025
c71f998
revert: quarto build-js
mcanouil Apr 7, 2025
be1a4d6
Merge branch 'main' into fix/issue12267
mcanouil Apr 7, 2025
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
31 changes: 25 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 @@ -12499,7 +12499,7 @@ var require_yaml_intelligence_resources = __commonJS({
}
]
},
description: "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
description: "The font files to include as an array (*i.e.*, `- path: <path>`). These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
}
},
required: [
Expand Down Expand Up @@ -19887,6 +19887,13 @@ var require_yaml_intelligence_resources = __commonJS({
},
errorMessage: "type key not supported at project type-level. Use `project: type: ...` instead.",
description: "internal-schema-hack"
},
{
name: "engines",
schema: {
arrayOf: "string"
},
description: "List execution engines you want to give priority when determining which engine should render a notebook. If two engines have support for a notebook, the one listed earlier will be chosen. Quarto's default order is 'knitr', 'jupyter', 'markdown', 'julia'."
}
],
"schema/schema.yml": [
Expand Down Expand Up @@ -23967,7 +23974,8 @@ var require_yaml_intelligence_resources = __commonJS({
},
"Disambiguating year suffix in author-date styles (e.g.&nbsp;\u201Ca\u201D in \u201CDoe,\n1999a\u201D).",
"Manuscript configuration",
"internal-schema-hack"
"internal-schema-hack",
"List execution engines you want to give priority when determining\nwhich engine should render a notebook. If two engines have support for a\nnotebook, the one listed earlier will be chosen. Quarto\u2019s default order\nis \u2018knitr\u2019, \u2018jupyter\u2019, \u2018markdown\u2019, \u2018julia\u2019."
],
"schema/external-schemas.yml": [
{
Expand Down Expand Up @@ -24196,12 +24204,12 @@ var require_yaml_intelligence_resources = __commonJS({
mermaid: "%%"
},
"handlers/mermaid/schema.yml": {
_internalId: 194269,
_internalId: 194322,
type: "object",
description: "be an object",
properties: {
"mermaid-format": {
_internalId: 194261,
_internalId: 194314,
type: "enum",
enum: [
"png",
Expand All @@ -24217,7 +24225,7 @@ var require_yaml_intelligence_resources = __commonJS({
exhaustiveCompletions: true
},
theme: {
_internalId: 194268,
_internalId: 194321,
type: "anyOf",
anyOf: [
{
Expand Down Expand Up @@ -33253,11 +33261,22 @@ var jupyterEngineSchema = defineCached(
},
"engine-jupyter"
);
var juliaEnginesSchema = defineCached(
// deno-lint-ignore require-await
async () => {
return {
schema: makeEngineSchema("julia"),
errorHandlers: []
};
},
"engine-julia"
);
async function getEngineOptionsSchema() {
const obj = {
markdown: await markdownEngineSchema(),
knitr: await knitrEngineSchema(),
jupyter: await jupyterEngineSchema()
jupyter: await jupyterEngineSchema(),
julia: await juliaEnginesSchema()
};
return obj;
}
Expand Down
31 changes: 25 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.

18 changes: 13 additions & 5 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 @@ -5471,7 +5471,7 @@
}
]
},
"description": "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
"description": "The font files to include as an array (*i.e.*, `- path: <path>`). These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
}
},
"required": [
Expand Down Expand Up @@ -12859,6 +12859,13 @@
},
"errorMessage": "type key not supported at project type-level. Use `project: type: ...` instead.",
"description": "internal-schema-hack"
},
{
"name": "engines",
"schema": {
"arrayOf": "string"
},
"description": "List execution engines you want to give priority when determining which engine should render a notebook. If two engines have support for a notebook, the one listed earlier will be chosen. Quarto's default order is 'knitr', 'jupyter', 'markdown', 'julia'."
}
],
"schema/schema.yml": [
Expand Down Expand Up @@ -16939,7 +16946,8 @@
},
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
"Manuscript configuration",
"internal-schema-hack"
"internal-schema-hack",
"List execution engines you want to give priority when determining\nwhich engine should render a notebook. If two engines have support for a\nnotebook, the one listed earlier will be chosen. Quarto’s default order\nis ‘knitr’, ‘jupyter’, ‘markdown’, ‘julia’."
],
"schema/external-schemas.yml": [
{
Expand Down Expand Up @@ -17168,12 +17176,12 @@
"mermaid": "%%"
},
"handlers/mermaid/schema.yml": {
"_internalId": 194269,
"_internalId": 194322,
"type": "object",
"description": "be an object",
"properties": {
"mermaid-format": {
"_internalId": 194261,
"_internalId": 194314,
"type": "enum",
"enum": [
"png",
Expand All @@ -17189,7 +17197,7 @@
"exhaustiveCompletions": true
},
"theme": {
"_internalId": 194268,
"_internalId": 194321,
"type": "anyOf",
"anyOf": [
{
Expand Down
2 changes: 1 addition & 1 deletion src/resources/schema/definitions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2954,7 +2954,7 @@
# string:
# pattern: '^U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?(?:,U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?)*$'
description: >
The font files to include. These can be local or online.
The font files to include as an array (*i.e.*, `- path: <path>`). These can be local or online.
Comment thread
gordonwoodhull marked this conversation as resolved.
Outdated
Local file paths should be relative to the `brand.yml` file.
Online paths should be complete URLs.
required: [files, family, source]
Expand Down
2 changes: 1 addition & 1 deletion src/resources/types/schema-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1469,7 +1469,7 @@ export type BrandFontFile = {
path: string;
style?: BrandFontStyle;
weight?: BrandFontWeight;
}))[] /* The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs. */;
}))[] /* The font files to include as an array (*i.e.*, `- path: <path>`). These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs. */;
source: "file";
}; /* A method for providing font files directly, either locally or from an online location. */

Expand Down