docs/hugo.yaml

353 lines
13 KiB
YAML

baseURL: https://v1-16.docs.dapr.io
title: Dapr Docs
# Output directory for generated site
publishDir: daprdocs/public
# Language settings
contentDir: content/en
defaultContentLanguage: en
defaultContentLanguageInSubdir: false
# Useful when translating.
enableMissingTranslationPlaceholders: true
enableRobotsTXT: true
# Will give values to .Lastmod etc.
enableGitInfo: true
# Comment out to disable taxonomies in Docsy
disableKinds: [taxonomy]
# You can add your own taxonomies
taxonomies:
tag: tags
category: categories
# Highlighting config
pygmentsCodeFences: true
pygmentsUseClasses: false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic: false
# pygmentsOptions: "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle: tango
# Configure how URLs look like per section.
permalinks:
blog: /:section/:year/:month/:day/:slug/
# Image processing configuration.
imaging:
resampleFilter: CatmullRom
quality: 75
anchor: Smart
# Language configuration
languages:
en:
languageName: English
title: Dapr Docs
weight: 1
contentDir: "daprdocs/content/en"
zh-hans:
languageName: 简体中文
title: Dapr 文档库
weight: 2
contentDir: "daprdocs/content/zh-hans"
services:
googleAnalytics:
enable: true
id: G-60C6Q1ETC1
menu:
main:
- name: Homepage
url: https://dapr.io
weight: 40
- name: GitHub
url: https://github.com/dapr
weight: 50
- name: Blog
url: https://blog.dapr.io/posts
weight: 60
- name: Discord
url: https://bit.ly/dapr-discord
weight: 70
- name: Community
url: https://dapr.io/community
weight: 80
markup:
goldmark:
parser:
attribute:
block: true
renderer:
unsafe: true
renderHooks:
link:
enableDefault: true
highlight:
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style: tango
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax: true
# Everything below this are Site Params
# Comment out if you don't want the "print entire section" link enabled.
outputs:
section: [HTML, print, RSS]
params:
taxonomy:
# set taxonomyCloud = [] to hide taxonomy clouds
taxonomyCloud: [tags, categories]
# If used, must have same length as taxonomyCloud
taxonomyCloudTitle: [Tag Cloud, Categories]
# set taxonomyPageHeader = [] to hide taxonomies on the page headers
taxonomyPageHeader: [tags, categories]
privacy_policy: https://policies.google.com/privacy
# First one is picked as the Twitter card image if not set on page.
# images: [images/project-illustration.png]
# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu: v1.16 (preview)
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version: false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version: v1.16
# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version: https://docs.dapr.io
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: https://github.com/dapr/docs
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: https://github.com/dapr/dapr
# Specify a value here if your content directory is not in your repo's root directory
github_subdir: "/daprdocs"
# Uncomment this if your GitHub repo does not have "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch: v1.16
versions:
- version: v1.16 (preview)
url: "#"
- version: v1.15 (latest)
url: "https://docs.dapr.io"
- version: v1.14
url: https://v1-14.docs.dapr.io
- version: v1.13
url: https://v1-13.docs.dapr.io
- version: v1.12
url: https://v1-12.docs.dapr.io
- version: v1.11
url: https://v1-11.docs.dapr.io
- version: v1.10
url: https://v1-10.docs.dapr.io
- version: v1.9
url: https://v1-9.docs.dapr.io
- version: v1.8
url: https://v1-8.docs.dapr.io
- version: v1.7
url: https://v1-7.docs.dapr.io
# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id: d72aa9b2712488cc3
# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting: false
copyright:
authors: The Dapr Authors
distributed: Documentation Distributed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
trademark: The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our [Trademark Usage](https://linuxfoundation.org/trademark-usage/) page.
from_year: 2018
search:
algolia:
appId: 'O0QLQGNF38'
apiKey: '54ae43aa28ce8f00c54c8d5f544d29b9'
indexName: daprdocs
offlineSearch: false
# User interface configuration
ui:
# Set to true to disable breadcrumb navigation.
breadcrumb_disable: false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo: true
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
navbar_translucent_over_cover_disable: false
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact: true
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable: true
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
feedback:
enable: false
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
'yes': >-
Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.
'no': >-
Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.
# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
readingtime:
enable: false
links:
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
user:
- name: YouTube
url: https://www.youtube.com/@darpdev
icon: fab fa-youtube
desc: Subscribe to our YouTube channel
- name: LinkedIn
url: https://www.linkedin.com/company/daprdev/
icon: fab fa-linkedin
desc: Follow us on LinkedIn to get the latest news!
- name: Twitter / X
url: https://twitter.com/daprdev
icon: fab fa-twitter
desc: Follow us on Twitter to get the latest news!
- name: BlueSky
url: https://bsky.app/profile/daprdev.bsky.social
icon: fab fa-bluesky
desc: Follow us on BlueSky to get the latest news!
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
developer:
- name: GitHub
url: https://github.com/dapr/
icon: fab fa-github
desc: Help contribute to Dapr!
- name: Discord
url: https://bit.ly/dapr-discord
icon: fab fa-discord
desc: Join our Discord server and talk with other Dapr developers
module:
hugoVersion:
extended: true
min: 0.146.0
imports:
- path: github.com/google/docsy
disable: false
mounts:
- source: daprdocs/content/en
target: content
lang: en
- source: daprdocs/static
target: static
- source: daprdocs/layouts
target: layouts
- source: daprdocs/data
target: data
- source: daprdocs/assets
target: assets
- source: daprdocs/archetypes
target: archetypes
- source: sdkdocs/python/daprdocs/content/en/python-sdk-docs
target: content/developing-applications/sdks/python
lang: en
- source: sdkdocs/python/daprdocs/content/en/python-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/php/daprdocs/content/en/php-sdk-docs
target: content/developing-applications/sdks/php
lang: en
- source: sdkdocs/dotnet/daprdocs/content/en/dotnet-sdk-docs
target: content/developing-applications/sdks/dotnet
lang: en
- source: sdkdocs/dotnet/daprdocs/content/en/dotnet-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/go/daprdocs/content/en/go-sdk-docs
target: content/developing-applications/sdks/go
lang: en
- source: sdkdocs/go/daprdocs/content/en/go-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/java/daprdocs/content/en/java-sdk-docs
target: content/developing-applications/sdks/java
lang: en
- source: sdkdocs/java/daprdocs/content/en/java-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/js/daprdocs/content/en/js-sdk-docs
target: content/developing-applications/sdks/js
lang: en
- source: sdkdocs/js/daprdocs/content/en/js-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/rust/daprdocs/content/en/rust-sdk-docs
target: content/developing-applications/sdks/rust
lang: en
- source: sdkdocs/rust/daprdocs/content/en/rust-sdk-contributing
target: content/contributing/sdk-contrib/
lang: en
- source: sdkdocs/pluggable-components/dotnet/daprdocs/content/en/dotnet-sdk-docs
target: content/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/pluggable-components-dotnet
lang: en
- source: sdkdocs/pluggable-components/go/daprdocs/content/en/go-sdk-docs
target: content/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/pluggable-components-go
lang: en
- source: translations/docs-zh/translated_content/zh_CN/docs
target: content
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/contributing
target: content/contributing/sdk-contrib/
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_python
target: content/developing-applications/sdks/python
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_php
target: content/developing-applications/sdks/php
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_dotnet
target: content/developing-applications/sdks/dotnet
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_java
target: content/developing-applications/sdks/java
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_go
target: content/developing-applications/sdks/go
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_js
target: content/developing-applications/sdks/js
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/sdks_rust
target: content/developing-applications/sdks/rust
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/pluggable-components/dotnet
target: content/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/pluggable-components-dotnet
lang: zh-hans
- source: translations/docs-zh/translated_content/zh_CN/pluggable-components/go
target: content/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/pluggable-components-go
lang: zh-hans