index : static-web-server.git

# Project information
site_name: Static Web Server
site_description: 'A blazing fast and asynchronous web server for static files-serving ⚡'
site_author: 'Jose Quintana'
site_url: https://sws.joseluisq.net
dev_addr: 0.0.0.0:8000

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

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

# Copyright
copyright: Copyright © 2019-2022 Jose Quintana

# Theme
theme:
  name: 'material'
  logo: assets/rust_logo.svg
  language: en
  include_sidebar: true
  features:
    - content.code.annotate
    - content.tabs.link
    - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.sections
    # - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    # - 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://camo.githubusercontent.com/a08032a2db94aea229991af8f73c45cc95174c8066dc7a6b1f88a79c94cf1093/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f7468756d622f642f64352f527573745f70726f6772616d6d696e675f6c616e67756167655f626c61636b5f6c6f676f2e7376672f3130323470782d527573745f70726f6772616d6d696e675f6c616e67756167655f626c61636b5f6c6f676f2e7376672e706e67

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:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.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

# Content Navigation
nav:
  - 'Overview': 'index.md'
  - 'Download and Install': 'download-and-install.md'
  - 'Getting Started': 'getting-started.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'
    - 'Logging': 'features/logging.md'
    - 'Compression': 'features/compression.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'
    - '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'
  - 'Platforms & Architectures': 'platforms-architectures.md'
  - 'Migration from v1 to v2': 'migration.md'
  - 'Changelog v2 (latest stable)': 'https://github.com/joseluisq/static-web-server/blob/master/CHANGELOG.md'
  - 'Changelog v1 (stable)': 'https://github.com/joseluisq/static-web-server/blob/1.x/CHANGELOG.md'
  - 'Semantic Versioning': 'semantic-versioning.md'
  - 'Contributions': 'contributions.md'
  - 'License': 'license.md'