xref: /aosp_15_r20/external/skia/site/config.toml (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard WorkerbaseURL = "/"
2*c8dee2aaSAndroid Build Coastguard Workertitle = "Skia"
3*c8dee2aaSAndroid Build Coastguard Worker
4*c8dee2aaSAndroid Build Coastguard WorkerenableRobotsTXT = false
5*c8dee2aaSAndroid Build Coastguard Worker
6*c8dee2aaSAndroid Build Coastguard Worker# Hugo allows theme composition (and inheritance). The precedence is from left to right.
7*c8dee2aaSAndroid Build Coastguard Workertheme = ["docsy"]
8*c8dee2aaSAndroid Build Coastguard Worker
9*c8dee2aaSAndroid Build Coastguard Worker# Will give values to .Lastmod etc.
10*c8dee2aaSAndroid Build Coastguard WorkerenableGitInfo = false
11*c8dee2aaSAndroid Build Coastguard Worker
12*c8dee2aaSAndroid Build Coastguard WorkerdisableKinds = ["taxonomy", "taxonomyTerm"]
13*c8dee2aaSAndroid Build Coastguard Worker
14*c8dee2aaSAndroid Build Coastguard Worker# Highlighting config
15*c8dee2aaSAndroid Build Coastguard WorkerpygmentsCodeFences = true
16*c8dee2aaSAndroid Build Coastguard WorkerpygmentsUseClasses = false
17*c8dee2aaSAndroid Build Coastguard Worker# Use the new Chroma Go highlighter in Hugo.
18*c8dee2aaSAndroid Build Coastguard WorkerpygmentsUseClassic = false
19*c8dee2aaSAndroid Build Coastguard Worker#pygmentsOptions = "linenos=table"
20*c8dee2aaSAndroid Build Coastguard Worker# See https://help.farbox.com/pygments.html
21*c8dee2aaSAndroid Build Coastguard WorkerpygmentsStyle = "tango"
22*c8dee2aaSAndroid Build Coastguard Worker
23*c8dee2aaSAndroid Build Coastguard Worker# Configure how URLs look like per section.
24*c8dee2aaSAndroid Build Coastguard Worker[permalinks]
25*c8dee2aaSAndroid Build Coastguard Workerblog = "/:section/:year/:month/:day/:slug/"
26*c8dee2aaSAndroid Build Coastguard Worker
27*c8dee2aaSAndroid Build Coastguard Worker## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
28*c8dee2aaSAndroid Build Coastguard Worker[blackfriday]
29*c8dee2aaSAndroid Build Coastguard WorkerplainIDAnchors = true
30*c8dee2aaSAndroid Build Coastguard WorkerhrefTargetBlank = true
31*c8dee2aaSAndroid Build Coastguard WorkerangledQuotes = false
32*c8dee2aaSAndroid Build Coastguard WorkerlatexDashes = true
33*c8dee2aaSAndroid Build Coastguard Worker
34*c8dee2aaSAndroid Build Coastguard Worker# Image processing configuration.
35*c8dee2aaSAndroid Build Coastguard Worker[imaging]
36*c8dee2aaSAndroid Build Coastguard WorkerresampleFilter = "CatmullRom"
37*c8dee2aaSAndroid Build Coastguard Workerquality = 75
38*c8dee2aaSAndroid Build Coastguard Workeranchor = "smart"
39*c8dee2aaSAndroid Build Coastguard Worker
40*c8dee2aaSAndroid Build Coastguard Worker[services]
41*c8dee2aaSAndroid Build Coastguard Worker[services.googleAnalytics]
42*c8dee2aaSAndroid Build Coastguard Worker# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
43*c8dee2aaSAndroid Build Coastguard Workerid = "UA-18058-16"
44*c8dee2aaSAndroid Build Coastguard Worker
45*c8dee2aaSAndroid Build Coastguard Worker# Language configuration
46*c8dee2aaSAndroid Build Coastguard Worker
47*c8dee2aaSAndroid Build Coastguard Worker[languages]
48*c8dee2aaSAndroid Build Coastguard Worker[languages.en]
49*c8dee2aaSAndroid Build Coastguard Workertitle = "Skia"
50*c8dee2aaSAndroid Build Coastguard Workerdescription = "2D Graphics Library"
51*c8dee2aaSAndroid Build Coastguard WorkerlanguageName ="English"
52*c8dee2aaSAndroid Build Coastguard Worker# Weight used for sorting.
53*c8dee2aaSAndroid Build Coastguard Workerweight = 1
54*c8dee2aaSAndroid Build Coastguard Worker
55*c8dee2aaSAndroid Build Coastguard Worker[markup]
56*c8dee2aaSAndroid Build Coastguard Worker  [markup.goldmark]
57*c8dee2aaSAndroid Build Coastguard Worker    [markup.goldmark.renderer]
58*c8dee2aaSAndroid Build Coastguard Worker      unsafe = true
59*c8dee2aaSAndroid Build Coastguard Worker  [markup.highlight]
60*c8dee2aaSAndroid Build Coastguard Worker      # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
61*c8dee2aaSAndroid Build Coastguard Worker      style = "tango"
62*c8dee2aaSAndroid Build Coastguard Worker      # Uncomment if you want your chosen highlight style used for code blocks without a specified language
63*c8dee2aaSAndroid Build Coastguard Worker      # guessSyntax = "true"
64*c8dee2aaSAndroid Build Coastguard Worker
65*c8dee2aaSAndroid Build Coastguard Worker# Everything below this are Site Params
66*c8dee2aaSAndroid Build Coastguard Worker
67*c8dee2aaSAndroid Build Coastguard Worker[params]
68*c8dee2aaSAndroid Build Coastguard Workercopyright = "Google"
69*c8dee2aaSAndroid Build Coastguard Workerprivacy_policy = "https://policies.google.com/privacy"
70*c8dee2aaSAndroid Build Coastguard Worker
71*c8dee2aaSAndroid Build Coastguard Worker# First one is picked as the Twitter card image if not set on page.
72*c8dee2aaSAndroid Build Coastguard Worker# images = ["images/project-illustration.png"]
73*c8dee2aaSAndroid Build Coastguard Worker
74*c8dee2aaSAndroid Build Coastguard Worker# Menu title if your navbar has a versions selector to access old versions of your site.
75*c8dee2aaSAndroid Build Coastguard Worker# This menu appears only if you have at least one [params.versions] set.
76*c8dee2aaSAndroid Build Coastguard Workerversion_menu = "Releases"
77*c8dee2aaSAndroid Build Coastguard Worker
78*c8dee2aaSAndroid Build Coastguard Worker# Flag used in the "version-banner" partial to decide whether to display a
79*c8dee2aaSAndroid Build Coastguard Worker# banner on every page indicating that this is an archived version of the docs.
80*c8dee2aaSAndroid Build Coastguard Worker# Set this flag to "true" if you want to display the banner.
81*c8dee2aaSAndroid Build Coastguard Workerarchived_version = false
82*c8dee2aaSAndroid Build Coastguard Worker
83*c8dee2aaSAndroid Build Coastguard Worker# The version number for the version of the docs represented in this doc set.
84*c8dee2aaSAndroid Build Coastguard Worker# Used in the "version-banner" partial to display a version number for the
85*c8dee2aaSAndroid Build Coastguard Worker# current doc set.
86*c8dee2aaSAndroid Build Coastguard Workerversion = "0.0"
87*c8dee2aaSAndroid Build Coastguard Worker
88*c8dee2aaSAndroid Build Coastguard Worker# A link to latest version of the docs. Used in the "version-banner" partial to
89*c8dee2aaSAndroid Build Coastguard Worker# point people to the main doc site.
90*c8dee2aaSAndroid Build Coastguard Workerurl_latest_version = "https://skia.org"
91*c8dee2aaSAndroid Build Coastguard Worker
92*c8dee2aaSAndroid Build Coastguard Worker# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
93*c8dee2aaSAndroid Build Coastguard Worker# github_repo = "https://github.com/google/skia"
94*c8dee2aaSAndroid Build Coastguard Worker# An optional link to a related project repo. For example, the sibling repository where your product code lives.
95*c8dee2aaSAndroid Build Coastguard Worker#github_project_repo = "https://github.com/google/docsy"
96*c8dee2aaSAndroid Build Coastguard Worker
97*c8dee2aaSAndroid Build Coastguard Worker# Specify a value here if your content directory is not in your repo's root directory
98*c8dee2aaSAndroid Build Coastguard Worker#github_subdir = "site2"
99*c8dee2aaSAndroid Build Coastguard Worker
100*c8dee2aaSAndroid Build Coastguard Worker# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
101*c8dee2aaSAndroid Build Coastguard Worker# or specify a new value if you want to reference another branch in your GitHub links
102*c8dee2aaSAndroid Build Coastguard Worker# github_branch= "main"
103*c8dee2aaSAndroid Build Coastguard Worker
104*c8dee2aaSAndroid Build Coastguard Worker# Google Custom Search Engine ID. Remove or comment out to disable search.
105*c8dee2aaSAndroid Build Coastguard Workergcs_engine_id = "009791159600898516779:8-nlv0iznho"
106*c8dee2aaSAndroid Build Coastguard Worker
107*c8dee2aaSAndroid Build Coastguard Worker# Enable Algolia DocSearch
108*c8dee2aaSAndroid Build Coastguard Workeralgolia_docsearch = false
109*c8dee2aaSAndroid Build Coastguard Worker
110*c8dee2aaSAndroid Build Coastguard Worker# Enable Lunr.js offline search
111*c8dee2aaSAndroid Build Coastguard WorkerofflineSearch = false
112*c8dee2aaSAndroid Build Coastguard Worker
113*c8dee2aaSAndroid Build Coastguard Worker# Enable syntax highlighting and copy buttons on code blocks with Prism
114*c8dee2aaSAndroid Build Coastguard Workerprism_syntax_highlighting = false
115*c8dee2aaSAndroid Build Coastguard Worker
116*c8dee2aaSAndroid Build Coastguard Worker# User interface configuration
117*c8dee2aaSAndroid Build Coastguard Worker[params.ui]
118*c8dee2aaSAndroid Build Coastguard Worker# Enable to show the side bar menu in its compact state.
119*c8dee2aaSAndroid Build Coastguard Workersidebar_menu_compact = false
120*c8dee2aaSAndroid Build Coastguard Worker#  Set to true to disable breadcrumb navigation.
121*c8dee2aaSAndroid Build Coastguard Workerbreadcrumb_disable = false
122*c8dee2aaSAndroid Build Coastguard Worker#  Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
123*c8dee2aaSAndroid Build Coastguard Workersidebar_search_disable = false
124*c8dee2aaSAndroid Build Coastguard Worker#  Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
125*c8dee2aaSAndroid Build Coastguard Workernavbar_logo = false
126*c8dee2aaSAndroid Build Coastguard Worker# Set to true to disable the About link in the site footer
127*c8dee2aaSAndroid Build Coastguard Workerfooter_about_disable = false
128*c8dee2aaSAndroid Build Coastguard Worker
129*c8dee2aaSAndroid Build Coastguard Worker# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
130*c8dee2aaSAndroid Build Coastguard Worker# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
131*c8dee2aaSAndroid Build Coastguard Worker# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
132*c8dee2aaSAndroid Build Coastguard Worker# add "hide_feedback: true" to the page's front matter.
133*c8dee2aaSAndroid Build Coastguard Worker[params.ui.feedback]
134*c8dee2aaSAndroid Build Coastguard Workerenable = false
135*c8dee2aaSAndroid Build Coastguard Worker# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
136*c8dee2aaSAndroid Build Coastguard Workeryes = 'Glad to hear it! Please <a href="https://bugs.chromium.org/p/skia/issues/entry">tell us how we can improve</a>.'
137*c8dee2aaSAndroid Build Coastguard Workerno = 'Sorry to hear that. Please <a href="https://bugs.chromium.org/p/skia/issues/entry">tell us how we can improve</a>.'
138*c8dee2aaSAndroid Build Coastguard Worker
139*c8dee2aaSAndroid Build Coastguard Worker# Adds a reading time to the top of each doc.
140*c8dee2aaSAndroid Build Coastguard Worker# If you want this feature, but occasionally need to remove the Reading time from a single page,
141*c8dee2aaSAndroid Build Coastguard Worker# add "hide_readingtime: true" to the page's front matter
142*c8dee2aaSAndroid Build Coastguard Worker[params.ui.readingtime]
143*c8dee2aaSAndroid Build Coastguard Workerenable = false
144*c8dee2aaSAndroid Build Coastguard Worker
145*c8dee2aaSAndroid Build Coastguard Worker[params.links]
146*c8dee2aaSAndroid Build Coastguard Worker# End user relevant links. These will show up on left side of footer and in the community page if you have one.
147*c8dee2aaSAndroid Build Coastguard Worker[[params.links.user]]
148*c8dee2aaSAndroid Build Coastguard Worker	name = "User mailing list"
149*c8dee2aaSAndroid Build Coastguard Worker	url = "https://groups.google.com/g/skia-discuss"
150*c8dee2aaSAndroid Build Coastguard Worker	icon = "fa fa-envelope"
151*c8dee2aaSAndroid Build Coastguard Worker        desc = "Discussion and help"
152*c8dee2aaSAndroid Build Coastguard Worker#[[params.links.user]]
153*c8dee2aaSAndroid Build Coastguard Worker#	name ="Twitter"
154*c8dee2aaSAndroid Build Coastguard Worker#	url = "https://example.org/twitter"
155*c8dee2aaSAndroid Build Coastguard Worker#	icon = "fab fa-twitter"
156*c8dee2aaSAndroid Build Coastguard Worker#        desc = "Follow us on Twitter to get the latest news!"
157*c8dee2aaSAndroid Build Coastguard Worker#[[params.links.user]]
158*c8dee2aaSAndroid Build Coastguard Worker#	name = "Stack Overflow"
159*c8dee2aaSAndroid Build Coastguard Worker#	url = "https://example.org/stack"
160*c8dee2aaSAndroid Build Coastguard Worker#	icon = "fab fa-stack-overflow"
161*c8dee2aaSAndroid Build Coastguard Worker#        desc = "Practical questions and curated answers"
162*c8dee2aaSAndroid Build Coastguard Worker# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
163*c8dee2aaSAndroid Build Coastguard Worker[[params.links.developer]]
164*c8dee2aaSAndroid Build Coastguard Worker	name = "GitHub"
165*c8dee2aaSAndroid Build Coastguard Worker	url = "https://github.com/google/skia"
166*c8dee2aaSAndroid Build Coastguard Worker	icon = "fab fa-github"
167*c8dee2aaSAndroid Build Coastguard Worker        desc = "Development takes place here!"
168*c8dee2aaSAndroid Build Coastguard Worker#[[params.links.developer]]
169*c8dee2aaSAndroid Build Coastguard Worker#	name = "Slack"
170*c8dee2aaSAndroid Build Coastguard Worker#	url = "https://example.org/slack"
171*c8dee2aaSAndroid Build Coastguard Worker#	icon = "fab fa-slack"
172*c8dee2aaSAndroid Build Coastguard Worker#        desc = "Chat with other project developers"
173*c8dee2aaSAndroid Build Coastguard Worker#[[params.links.developer]]
174*c8dee2aaSAndroid Build Coastguard Worker#	name = "Developer mailing list"
175*c8dee2aaSAndroid Build Coastguard Worker#	url = "https://example.org/mail"
176*c8dee2aaSAndroid Build Coastguard Worker#	icon = "fa fa-envelope"
177*c8dee2aaSAndroid Build Coastguard Worker#        desc = "Discuss development issues around the project"
178*c8dee2aaSAndroid Build Coastguard Worker
179*c8dee2aaSAndroid Build Coastguard Worker[params.mermaid]
180*c8dee2aaSAndroid Build Coastguard Workerenable = true
181