mirror of https://github.com/knative/docs.git
112 lines
3.0 KiB
YAML
112 lines
3.0 KiB
YAML
INHERIT: config/redirects.yml
|
|
|
|
site_name: Knative
|
|
site_url: https://knative.dev/
|
|
site_description: Knative Documentation
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
# Don't try to make snippets into regular docs (e.g. link-checking, nav, etc)
|
|
exclude_docs: |
|
|
*docs/snippets/
|
|
|
|
# TODO: make these stricter (move to "warn" to flag new link breakages)
|
|
# validation:
|
|
# omitted_files: warn
|
|
# absolute_links: relative_to_docs
|
|
# anchors: warn
|
|
# unrecognized_links: warn
|
|
|
|
repo_url: https://github.com/knative/docs
|
|
edit_uri: edit/main/docs
|
|
|
|
theme:
|
|
name: material
|
|
logo: images/logo/rgb/knative-logo-rgb.png
|
|
favicon: images/favicon.ico
|
|
custom_dir: overrides
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.top
|
|
- navigation.tracking
|
|
- navigation.indexes
|
|
- content.code.copy
|
|
- content.action.edit
|
|
|
|
markdown_extensions:
|
|
# - mdx_include:
|
|
# base_path: docs
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- attr_list
|
|
- meta
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.details
|
|
- pymdownx.snippets:
|
|
base_path: docs/snippets
|
|
- pymdownx.keys
|
|
- pymdownx.caret
|
|
- pymdownx.mark
|
|
- pymdownx.tilde
|
|
- pymdownx.escapeall
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- admonition
|
|
- toc:
|
|
permalink: true
|
|
- def_list
|
|
|
|
plugins:
|
|
search:
|
|
# Spaces, dashes, periods and forward-slash (so serving.knative.dev/blibble can be searched as blibble).
|
|
separator: '[\/\s\-\.]+'
|
|
exclude:
|
|
glob:
|
|
# Exclude files that are built into other parts of the documentation
|
|
- snippets/*
|
|
- smoketest.md
|
|
# This plugin enables .nav.yaml files for subtree navigation
|
|
# (as well as automatic generation of index pages, which we should consider).
|
|
awesome-nav:
|
|
enabled: true
|
|
rss:
|
|
match_path: "blog/(articles|steering|events|releases)/.*"
|
|
feeds_filenames:
|
|
rss_created: "blog/feed_rss_created.xml"
|
|
rss_updated: "blog/feed_rss_updated.xml"
|
|
date_from_meta:
|
|
as_creation: "date"
|
|
datetime_format: "%Y-%m-%d"
|
|
# Allow `.meta.yml` to define metadata for all pages below that directory.
|
|
# See https://squidfunk.github.io/mkdocs-material/plugins/meta/
|
|
meta:
|
|
enabled: true
|
|
macros:
|
|
module_name: hack/macros
|
|
include_dir: docs/snippets
|
|
|
|
copyright: "Copyright © 2025 The Knative Authors"
|
|
|
|
extra:
|
|
# social:
|
|
# - icon: fontawesome/brands/twitter
|
|
# link: https://twitter.com/KnativeProject
|
|
# - icon: fontawesome/brands/github
|
|
# link: https://github.com/knative/community
|
|
# name: Knative Community on Github
|
|
# - icon: fontawesome/brands/slack
|
|
# link: https://slack.cncf.io
|
|
# name: Slack
|
|
analytics:
|
|
provider: google
|
|
property: G-YRMNFYE32R
|
|
version:
|
|
provider: directory
|