static-web-server/docs/mkdocs.yml

# Project information
site_name: Static Web Server
site_description: 'A cross-platform, high-performance and asynchronous web server for static files-serving ⚡'
site_author: 'Jose Quintana'
site_url: https://static-web-server.net

# Repository
repo_name: static-web-server/static-web-server
repo_url: https://github.com/static-web-server/static-web-server/
edit_uri: edit/master/docs/content/

strict: true
docs_dir: 'docs/content'
site_dir: '/tmp/docs'
extra_css:
  - 'assets/style.css'

# Copyright
copyright: Copyright © 2019-2024 Jose Quintana

# Theme
theme:
  name: 'material'
  logo: assets/sws_white.svg
  language: en
  include_sidebar: true
  features:
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tabs.link
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.sections
    # - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    # - toc.integrate
  palette:
    - scheme: default
      primary: black
      accent: blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: 'Open Sans'
    code: 'Droid Sans Mono'
  favicon: https://static-web-server.net/assets/sws.svg

extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/joseluisq'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/joseluis_q'

markdown_extensions:
  - admonition
  - abbr
  - def_list
  - md_in_html
  - codehilite
  - admonition
  - meta
  - attr_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - markdown.extensions.tables
  - pymdownx.arithmatex
  - pymdownx.betterem
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      provider: "github"
      user: "facelessuser"
      repo: "pymdown-extensions"
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.tasklist
  - pymdownx.highlight:
      linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.tabbed:
      alternate_style: true

# Plugins
plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      type: timeago
      custom_format: "%d. %B %Y"
      timezone: Europe/Berlin
      locale: en
      fallback_to_build_date: false
      enable_creation_date: false
      exclude:
        - index.md
      enabled: true
      strict: true

# Content Navigation
nav:
  - 'Overview': 'index.md'
  - 'Getting Started': 'getting-started.md'
  - 'Download and Install': 'download-and-install.md'
  - 'Configuration':
    - 'Command Line Arguments': 'configuration/command-line-arguments.md'
    - 'Environment Variables': 'configuration/environment-variables.md'
    - 'TOML Configuration File': 'configuration/config-file.md'
  - 'Building from Source': 'building-from-source.md'
  - 'Features':
    - 'HTTP/1': 'features/http1.md'
    - 'HTTP Methods': 'features/http-methods.md'
    - 'HTTP/2 and TLS': 'features/http2-tls.md'
    - 'HTTP to HTTPS redirect': 'features/http-https-redirect.md'
    - 'Logging': 'features/logging.md'
    - 'Compression': 'features/compression.md'
    - 'Pre-compressed files serving': 'features/compression-static.md'
    - 'Cache Control Headers': 'features/cache-control-headers.md'
    - 'CORS': 'features/cors.md'
    - 'Security Headers': 'features/security-headers.md'
    - 'Basic Authentication': 'features/basic-authentication.md'
    - 'Directory Listing': 'features/directory-listing.md'
    - 'Docker': 'features/docker.md'
    - 'Graceful Shutdown': 'features/graceful-shutdown.md'
    - 'File Descriptor Socket Passing': './features/file-descriptor-socket-passing.md'
    - 'Worker Threads Customization': 'features/worker-threads.md'
    - 'Blocking Threads Customization': 'features/blocking-threads.md'
    - 'Error Pages': 'features/error-pages.md'
    - 'Custom HTTP Headers': 'features/custom-http-headers.md'
    - 'URL Rewrites': 'features/url-rewrites.md'
    - 'URL Redirects': 'features/url-redirects.md'
    - 'Windows Service': 'features/windows-service.md'
    - 'Trailing Slash Redirect': 'features/trailing-slash-redirect.md'
    - 'Ignore Files': 'features/ignore-files.md'
    - 'Disable Symlinks': 'features/disable-symlinks.md'
    - 'Health endpoint': 'features/health-endpoint.md'
    - 'Virtual Hosting': 'features/virtual-hosting.md'
    - 'Multiple Index Files': 'features/multiple-index-files.md'
    - 'Maintenance Mode': 'features/maintenance-mode.md'
    - 'WebAssembly': 'features/webassembly.md'
    - 'Man Pages and Shell Completions': 'features/man-pages-completions.md'
    - 'Markdown Content Negotiation': 'features/markdown-content-negotiation.md'
  - 'Platforms & Architectures': 'platforms-architectures.md'
  - 'Migrating from v1 to v2': 'migration.md'
  - 'Changelog v2 (stable)': 'https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md'
  - 'Changelog v1 (deprecated)': 'https://github.com/static-web-server/static-web-server/releases/tag/v1.19.4'
  - 'Semantic Versioning': 'semantic-versioning.md'
  - 'Report Security Issues': 'report-security-issues.md'
  - 'Contributions': 'contributions.md'
  - 'Showcases': 'showcases.md'
  - 'License': 'license.md'

not_in_nav: |
  download-and-install.template.md

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn