CoCalc -- document-links.yml

GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/schema/document-links.yml
¹²⁹²¹ views
1
- name: link-external-icon
2
  tags:
3
    formats: [$html-doc, revealjs]
4
  schema: boolean
5
  description: "Show a special icon next to links that leave the current site."
6

7
- name: link-external-newwindow
8
  tags:
9
    formats: [$html-doc, revealjs]
10
  schema: boolean
11
  description: "Open external links in a new browser window or tab (rather than navigating the current tab)."
12

13
- name: link-external-filter
14
  tags:
15
    formats: [$html-doc, revealjs]
16
  schema: string
17
  description:
18
    short: "A regular expression that can be used to determine whether a link is an internal link."
19
    long: |
20
      A regular expression that can be used to determine whether a link is an internal link. For example, 
21
      the following will treat links that start with `http://www.quarto.org/custom` or `https://www.quarto.org/custom`
22
      as internal links (and others will be considered external):
23

24
      ```
25
      ^(?:http:|https:)\/\/www\.quarto\.org\/custom
26
      ```
27

28
- name: format-links
29
  tags:
30
    formats: [$html-doc]
31
  schema:
32
    anyOf:
33
      - boolean
34
      - maybeArrayOf:
35
          anyOf:
36
            - string
37
            - object:
38
                properties:
39
                  text:
40
                    string:
41
                      description: "The title for the link."
42
                  href:
43
                    string:
44
                      description: "The href for the link."
45
                  icon:
46
                    string:
47
                      description: "The icon for the link."
48
                required: [text, href]
49
            - object:
50
                properties:
51
                  format:
52
                    string:
53
                      description: "The format that this link represents."
54
                  text:
55
                    string:
56
                      description: "The title for this link."
57
                  icon:
58
                    string:
59
                      description: "The icon for this link."
60
                required: [text, format]
61

62
  description:
63
    short: "Controls whether links to other rendered formats are displayed in HTML output."
64
    long: |
65
      Controls whether links to other rendered formats are displayed in HTML output.
66

67
      Pass `false` to disable the display of format lengths or pass a list of format names for which you'd
68
      like links to be shown.
69

70
- name: notebook-links
71
  tags:
72
    formats: [$html-doc]
73
  schema:
74
    anyOf:
75
      - boolean
76
      - enum: [inline, global]
77
  description:
78
    short: "Controls the display of links to notebooks that provided embedded content or are created from documents."
79
    long: |
80
      Controls the display of links to notebooks that provided embedded content or are created from documents.
81

82
      Specify `false` to disable linking to source Notebooks. Specify `inline` to show links to source notebooks beneath the content they provide. 
83
      Specify `global` to show a set of global links to source notebooks.
84

85
- name: other-links
86
  tags:
87
    formats: [$html-doc]
88
  schema:
89
    anyOf:
90
      - enum: [false]
91
      - ref: other-links
92
  description: "A list of links that should be displayed below the table of contents in an `Other Links` section."
93

94
- name: code-links
95
  tags:
96
    formats: [$html-doc]
97
  schema:
98
    anyOf:
99
      - enum: [false]
100
      - ref: code-links-schema
101
  description: "A list of links that should be displayed below the table of contents in an `Code Links` section."
102

103
- name: notebook-subarticles
104
  tags:
105
    formats: [$jats-all]
106
  schema: boolean
107
  description:
108
    short: "Controls whether referenced notebooks are embedded in JATS output as subarticles."
109
    long: |
110
      Controls the display of links to notebooks that provided embedded content or are created from documents.
111

112
      Defaults to `true` - specify `false` to disable embedding Notebook as subarticles with the JATS output.
113

114
- name: notebook-view
115
  tags:
116
    formats: [$html-doc]
117
  schema:
118
    anyOf:
119
      - boolean
120
      - maybeArrayOf:
121
          anyOf:
122
            - string
123
            - ref: notebook-view-schema
124
  description: "Configures the HTML viewer for notebooks that provide embedded content."
125

126
- name: notebook-view-style
127
  tags:
128
    formats: [$html-doc]
129
  schema:
130
    enum: [document, notebook]
131
  hidden: true
132
  description: "The style of document to render. Setting this to `notebook` will create additional notebook style affordances."
133

134
- name: notebook-preview-options
135
  tags:
136
    formats: [$html-doc]
137
  schema:
138
    object:
139
      properties:
140
        back:
141
          boolean:
142
            description: "Whether to show a back button in the notebook preview."
143
  description: "Options for controlling the display and behavior of Notebook previews."
144

145
- name: canonical-url
146
  tags:
147
    formats: [$html-doc]
148
  schema:
149
    anyOf:
150
      - boolean
151
      - string
152
  description:
153
    short: "Include a canonical link tag in website pages"
154
    long: |
155
      Include a canonical link tag in website pages. You may pass either `true` to 
156
      automatically generate a canonical link, or pass a canonical url that you'd like
157
      to have placed in the `href` attribute of the tag.
158

159
      Canonical links can only be generated for websites with a known `site-url`.
160

161
Product

Resources

Company
