hugo.yaml

# cSpell:ignore docsy github goldmark linkify netlify

baseURL: https://cncf-docsy-starter.netlify.app/ # CUSTOMIZE
title: Docsy Starter # CUSTOMIZE
disableKinds: [taxonomy]
theme: [docsy]
enableGitInfo: true

#
# Outputs and Netlify _redirects file support
#

disableAliases: true # We do redirects via Netlify's _redirects file

mediaTypes:
  text/netlify: {}

outputFormats:
  REDIRECTS:
    mediaType: text/netlify
    baseName: _redirects
    notAlternative: true

outputs:
  home: [HTML]
  section: [HTML]

#
# Language settings
#

enableMissingTranslationPlaceholders: true
defaultContentLanguage: en

languages:
  en:
    languageName: English
    languageCode: en-US
    params:
      description: Docsy starter # CUSTOMIZE

#
# Markup and imaging
#

markup:
  goldmark:
    extensions:
      linkify: false
    parser:
      attribute:
        block: true
      wrapStandAloneImageWithinParagraph: false
    renderer:
      unsafe: true
  highlight:
    noClasses: false # Required for dark-mode
  tableOfContents: { endLevel: 4 }

imaging:
  resampleFilter: CatmullRom # cspell:disable-line
  quality: 75
  anchor: smart

params:
  copyright:
    authors: >-
      Project Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0)
      |
    # from_year: 2024
  github_repo: https://github.com/chalin/docsy-starter
  gcs_engine_id: 011217106833237091527:la2vtv2emlw # CUSTOMIZE # FIXME get an ID for the starter?
  privacy_policy: https://www.linuxfoundation.org/legal/privacy-policy
  ui:
    showLightDarkModeMenu: true
    sidebar_cache_limit: 10
    sidebar_menu_compact: true
    sidebar_menu_foldable: false
    sidebar_search_disable: false
    feedback: # CUSTOMIZE
      enable: false # FIXME: setting to false until the feedback can be better configured
      'yes': >-
        Glad to hear it! Please <a
        href="https://github.com/google/docsy/issues/new">tell us how we can
        improve</a>.
      'no': >-
        Sorry to hear that. Please <a
        href="https://github.com/google/docsy/issues/new">tell us how we can
        improve</a>.
  links: # CUSTOMIZE
    user:
      - name: GitHub Discussions
        url: https://github.com/google/docsy/discussions
        icon: fa-brands fa-github
        desc: Discussion and help from your fellow users
      - name: User mailing list
        url: https://groups.google.com/forum/#!forum/docsy-users
        icon: fa-solid fa-envelope
        desc: Sign up for Docsy announcements
      - name: Twitter
        url: https://twitter.com/docsydocs
        icon: fa-brands fa-x-twitter
        desc: Follow us on Twitter to get the latest news!
      - name: Stack Overflow
        url: https://stackoverflow.com/questions/tagged/docsy
        icon: fa-brands fa-stack-overflow
        desc: Practical questions and curated answers
    developer:
      - name: GitHub
        url: https://github.com/google/docsy
        icon: fa-brands fa-github
        desc: Development takes place here!

module:
  mounts:
    - source: content/en
      target: content