config.toml

# full override: we're not tracking changes to the docsy base file.

baseURL = "https://www.cloudwego.io"
title = "CloudWeGo"
googleAnalytics = "G-QYWRQRLPRM"

enableRobotsTXT = true

# Will give values to .Lastmod etc.
enableGitInfo = true

# Language settings
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

#disableKinds = ["taxonomy", "taxonomyTerm"]
[taxonomies]
projects = "projects"

[params.taxonomy]
taxonomyCloud = ["projects"]
taxonomyCloudTitle = ["taxo.projects.title"]
taxonomyPageHeader = ["projects"]            # i18n prefix taxo.page.header

# 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/"

## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

# Language configuration

[languages]
[languages.en]
contentDir = "content/en"
title = "CloudWeGo"
languageName = "English"
# Weight used for sorting.
weight = 1

[languages.en.params]
description = "A leading practice for building enterprise cloud native middleware!"

[languages.zh]
contentDir = "content/zh"
title = "CloudWeGo"
languageName = "中文"
# Weight used for sorting.
weight = 1

[[languages.zh.menus.main]]
name = "新手视频"
url = "https://space.bilibili.com/3494360534485730/channel/collectiondetail?sid=2632484"
weight = 60
parent = "社区"

[languages.zh.params]
description = "A leading practice for building enterprise cloud native middleware!"

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.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"]

[params]
time_format_blog = "Monday, January 02, 2006"
time_format_default = "January 2, 2006"
# Sections to publish in the main RSS feed.
rss_sections = ["blog"]
copyright = "The CloudWeGo Authors"


# 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 = "Releases"

# 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 = "0.0"

# 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://example.com"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/cloudwego/cloudwego.github.io"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/cloudwego/kitex"

github_org = "https://github.com/cloudwego"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch = "main"

# Enable Algolia DocSearch
algolia_docsearch = true

# Enable Lunr.js offline search
offlineSearch = false

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = true

# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = false
# Show expand/collapse icon for sidebar sections.
sidebar_menu_foldable = true
#  Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
#  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
#  Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = "/img/logo.png"
# Set to true to disable the About link in the site footer
footer_about_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.
[params.ui.feedback]
enable = true
# 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
[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
# [[params.links.user]]
# name = "CloudWeGo"
# url = "https://github.com/cloudwego"
# desc = "Desc of CloudWeGo"


# For a full list of parameters used in Docsy sites, see:
# https://github.com/google/docsy-example/blob/master/config.toml

[params.footerLinks]
[[params.footerLinks.items]]
name = "About"
url = "/about/"
[[params.footerLinks.items]]
name = "License"
url = "https://github.com/cloudwego/cloudwego.github.io/blob/main/LICENSE"

[[params.links.user]]
name = "Lark"
type = "custom"
url = "https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=693v2544-2664-4421-b50f-7f1912p745r6"
icon = "/webfonts/lark.svg"
desc = "Chat with other CloudWeGo users by lark"

[[params.links.user]]
name = "Twitter"
type = "custom"
url = "https://twitter.com/CloudWeGo"
icon = "/webfonts/x-twitter.svg"
desc = "Follow us on Twitter to get the latest news!"

[[params.links.developer]]
name = "GitHub"
url = "https://github.com/cloudwego"
icon = "fab fa-github"
desc = "Development takes place here!"

[[params.links.developer]]
name = "Discord"
url = "https://discord.gg/jceZSE7DsW"
icon = "fab fa-discord"
desc = "Chat with other project developers"

[outputFormats]
[outputFormats.PRINT]
baseName = "index"
isHTML = true
mediaType = "text/html"
path = "_print"
permalinkable = false