config.yml

baseURL: "https://fluidframework.com/"
languageCode: "en-us"
refLinksErrorLevel: "WARNING"
theme: "thxvscode"
title: "Fluid Framework"
titleCaseStyle: "Chicago"

# Hugo modules enable mapping content from outside the Hugo folder
module:
  noVendor: "github.com/**"
  hugoVersion:
    extended: true
    min: "0.76.5"
  mounts:
    - source: content
      target: content
    - source: _replacements
      target: content
    - source: ../packages/dds/counter/README.md
      target: content/docs/counter-readme.md
    - source: ../packages/dds/sequence/README.md
      target: content/docs/sequence-readme.md

    - source: static
      target: static

    # SVG icons from the @vscode/codicons package
    - source: node_modules/@vscode/codicons/src/icons/beaker.svg
      target: static/codicons/beaker.svg
    - source: node_modules/@vscode/codicons/src/icons/book.svg
      target: static/codicons/book.svg
    - source: node_modules/@vscode/codicons/src/icons/bug.svg
      target: static/codicons/bug.svg
    - source: node_modules/@vscode/codicons/src/icons/comment-discussion.svg
      target: static/codicons/comment-discussion.svg
    - source: node_modules/@vscode/codicons/src/icons/edit.svg
      target: static/codicons/edit.svg
    - source: node_modules/@vscode/codicons/src/icons/github.svg
      target: static/codicons/github.svg
    - source: node_modules/@vscode/codicons/src/icons/play-circle.svg
      target: static/codicons/play-circle.svg
    - source: node_modules/@vscode/codicons/src/icons/rss.svg
      target: static/codicons/rss.svg
    - source: node_modules/@vscode/codicons/src/icons/twitter.svg
      target: static/codicons/twitter.svg

permalinks:
  page: "/:slug"
  post: "/:year/:month/:title"

params:
  appInsightKey: "" # This is provided by the build system as an env variable
  cookies: false
  customCSS: ["css/fluid.css", "css/tango.css", "css/carousel.css"]
  dateform: "Jan 2, 2006"
  dateformNum: "2006-01-02"
  dateformNumTime: "2006-01-02 15:04 -0700"
  dateformShort: "Jan 2"
  githubRepo: "microsoft/FluidFramework"
  twitterHandle: "fluidframework"
  banner:
    showBanner: true # show or hide the banner completely
    bannerClose: false # show or hide the close button on the banner
    version: "0.50"
    urlRef: "docs/updates/v0.50.md"
    message: | # if set, this will override the release notes updates
      Fluid Framework 2 is now in General Availability! <a href="https://aka.ms/fluid/release_blog"><u>Learn more.</u></a>

menu:
  main:
    - name: "Getting started"
      url: "/docs/start/quick-start/"
      weight: -100
    - name: "Docs"
      url: "/docs/"
      weight: -80
    - name: "Community"
      url: "/community/"
      weight: -60
    - name: "Support"
      url: "/Support/"
      weight: -20
  old_section:
    - identifier: "quick-start"
      name: "Quick Start"
      url: "/start/quick-start/"
      weight: -800
    - identifier: "tutorial"
      name: "Tutorial"
      url: "/start/tutorial/"
      weight: -700
    - identifier: "examples"
      name: "Examples"
      url: "/start/examples/"
      weight: -600

  # this menu supplements one generated in the apiNav partial
  docs:
    - identifier: "start"
      name: "Getting started"
      weight: -800
    - identifier: "build"
      name: "Build with Fluid"
      weight: -600
    - identifier: "testing"
      name: "Testing"
      weight: -500
    - identifier: "deployment"
      name: "Deployment"
      weight: -400
    - identifier: "DDS"
      name: "Data structures"
      weight: -300
    - identifier: "concepts"
      name: "Concepts"
      weight: -200
    - identifier: "faq"
      name: "FAQ"
      url: "/docs/faq/"
      weight: -100
    - identifier: "glossary"
      name: "Glossary"
      url: "/docs/glossary/"
      weight: -90
    - identifier: "updates"
      name: "Release notes"
      weight: -80

markup:
  goldmark:
    parser:
      attribute:
        # enables adding CSS classes to block elements in markdown
        block: true
    renderer:
      autoHeadingIDType: "github"
      # mark unsafe html as true since api-documenter uses html snippets in markdown
      unsafe: true
    extensions:
      definitionList: true
      footnote: true
      linkify: true
      strikethrough: true
      table: true
      taskList: true
      typographer: true

  highlight:
    codeFences: true
    guessSyntax: true
    hl_Lines: ""
    lineNoStart: 1
    # if you need to turn on line nos, use the highlight shortcode
    lineNos: false
    lineNumbersInTable: false
    noClasses: false
    tabWidth: 2

  tableOfContents:
    endLevel: 4
    ordered: false
    startLevel: 2