hugo.yaml

# basic site configuration - these settings control URLs, build output location, and content processing
baseURL: https://oss.anchore.com/
languageCode: en-us
title: 'Anchore Open Source'
publishDir: public/ # where the generated static site files are written
timeout: 180s # maximum time for building the site (important for large sites with many pages)
ignoreLogs:
  - warning-goldmark-raw-html
ignoreFiles: # patterns for files that should not be processed during site generation
  - content/docs/reference/.*/snippets/.*\.md$
  - content/docs/guides/sbom/snippets/.*\.md$
  - content/docs/capabilities/snippets/.*\.md$
  - data/(grant|grype|syft|sbom)/
enableGitInfo: true # adds last modified dates from git history to pages

# theme configuration - imports the Docsy theme which provides layout, styling, and navigation components
module:
  imports:
    - path: 'github.com/google/docsy'

# navigation menus - defines items shown in the top navbar (weight controls ordering, lower numbers appear first)
menus:
  main:
    - name: Enterprise Docs
      weight: -101
      pre: <i class='fas fa-book pr-2'></i>
      url: https://docs.anchore.com/current/
    - name: Events
      weight: -100
      pre: <i class='fas fa-calendar pr-2'></i>
      url: /docs/about/events/
    - name: Blog
      weight: -99
      pre: <i class='fas fa-rss pr-2'></i>
      url: https://anchore.com/blog/
    - name: GitHub
      weight: -98
      pre: <i class='fab fa-github pr-2'></i>
      url: https://github.com/anchore/
    - name: Discourse
      weight: -97
      pre: <i class='fab fa-discourse pr-2'></i>
      url: https://anchore.com/discourse

# sitemap configuration - generates sitemap.xml for search engines to discover and crawl pages
# Generate a minimal sitemap with just the URLs and last modification dates, without the optional hints that search engines ignore anyway.
# This is actually a best practice. Both changeFreq and priority are largely ignored by modern search engines:
#  - Google has explicitly stated they don't use these hints
#  - Search engines prefer to figure out crawl frequency and importance on their own
#  - Omitting them keeps the sitemap cleaner and avoids providing misleading information
sitemap:
  changeFreq: ''
  filename: sitemap.xml
  priority: -1

# custom site parameters - these variables are available in templates and control site-specific features
params:
  description: Anchore Open Source Documentation for SBOM creation and
    vulnerability detection
  copyright: Anchore Inc
  privacy_policy: https://anchore.com/privacy
  environment: development
  github_repo: https://github.com/anchore/oss-docs # enables "Edit this page" links and GitHub integration
  github_project_repo: https://github.com/anchore/oss-docs
  offlineSearch: false # when true, builds search index into site for offline use (increases site size)
  sidebar_groups: # organizes sidebar sections into collapsible groups with custom titles
    Capabilities:
      - id: 'overview'
        title: 'Overview'
      - id: 'os'
        title: 'OS Distro'
      - id: 'language'
        title: 'Language / Framework'
      - id: 'other'
        title: 'Other'
    Contributing:
      - id: 'general'
        title: 'General'
      - id: 'projects'
        title: 'Project Specific'
    Architecture:
      - id: 'general'
        title: 'General'
      - id: 'projects'
        title: 'Project Specific'
    Reference:
      - id: 'general'
        title: 'General'
      - id: 'syft'
        title: 'Syft'
        icon_image: '/images/logos/syft/favicon-48x48.png'
      - id: 'grype'
        title: 'Grype'
        icon_image: '/images/logos/grype/favicon-48x48.png'
      - id: 'grant'
        title: 'Grant'
        icon_image: '/images/logos/grant/favicon-48x48.png'
  links: # populates footer links organized by section (shown as icon links at bottom of pages)
    user:
      - name: OSS Docs home
        url: https://oss.anchore.com/
        icon: fas fa-home
        desc: Anchore OSS Docs Site
      - name: Anchore, Inc.
        url: https://anchore.com
        icon: fas fa-university
        desc: Anchore Company Site
    developer:
      - name: Twitter/X
        url: https://x.com/anchore
        icon: fab fa-x-twitter
        desc: Follow Anchore on Twitter/X
      - name: Youtube
        url: https://youtube.com/anchore
        icon: fab fa-youtube
        desc: Follow Anchore on Youtube
      - name: Mastodon
        url: https://mstdn.business/@anchore
        icon: fab fa-mastodon pr-2
        desc: Follow Anchore on Mastodon
      - name: BlueSky
        url: https://bsky.app/profile/anchore.com
        icon: fab fa-bluesky pr-2
        desc: Follow Anchore on BlueSky
      - name: Discourse
        url: https://anchore.com/discourse
        icon: fab fa-discourse
        desc: Discuss with developers on our Discourse
      - name: GitHub
        url: https://github.com/anchore
        icon: fab fa-square-github
        desc: Browse and contribute on GitHub!
  ui: # controls visual elements and behavior of the rendered site
    sidebar_menu_compact: true # reduces spacing in left sidebar navigation menu
    breadcrumb_disable: false # shows page path at top of content area
    sidebar_search_disable: false # removes the search dialog from the top of the left TOC sidebar
    navbar_translucent_over_cover_disable: true # keeps navbar opaque instead of transparent over hero images
    navbar_logo: true # displays site logo in the top navigation bar
    preload_fonts: # fonts to load early for faster rendering (reduces layout shift)
      - Poppins:400,500,600
    showLightDarkModeMenu: true # adds dark/light mode toggle button to top navbar
    # this is critical, we have a lot of sub-sections for ecosystems. We should not truncate these!
    sidebar_menu_truncate: 80 # maximum items shown in sidebar before truncating (prevents very long sidebars)
    feedback: # enables thumbs up/down feedback widget at bottom of pages
      yes: Glad to hear it! Please <a
        href="https://github.com/anchore/oss-docs-preview/issues/new">tell us
        how we can improve</a>.
      no: Sorry to hear that. Please <a
        href="https://github.com/anchore/oss-docs-preview/issues/new">tell us
        how we can improve</a>.
  print: # controls print layout when users print pages or save as PDF
    disable_toc: true # removes table of contents from printed version

# output formats - defines which file formats Hugo generates for different page types
outputs:
  home: # homepage outputs
    - HTML
  page: # individual page outputs
    - HTML
  section: # section index pages outputs (e.g., /docs/guides/)
    - HTML
    - RSS # generates RSS feed for section
    - print # generates printer-friendly version

# content rendering configuration - controls how markdown and code blocks are processed and displayed
markup:
  highlight: # syntax highlighting settings for code blocks
    codeFences: true # enables ``` fenced code blocks
    guessSyntax: true # attempts to detect language if not specified
    hl_Lines: ''
    lineNoStart: 1
    lineNos: false # disables line numbers in code blocks by default
    lineNumbersInTable: true # uses table layout for line numbers when enabled
    tabWidth: 4
    noClasses: true # uses inline styles instead of CSS classes
    style: dracula # color scheme for syntax highlighting
  goldmark: # markdown parser settings
    renderer:
      # used to allow raw HTML in markdown files
      unsafe: true # permits raw HTML tags in markdown content
    parser:
      attribute:
        block: true # enables attribute syntax for blocks
      autoHeadingIDType: github # generates GitHub-style heading IDs for anchor links
      autoHeadingAnchor: true # automatically adds anchor links to headings

capitalizeListTitles: false # do not capitalize tags