mkdocs.yml

site_name: CodaLab Worksheets Documentation
docs_dir: docs
theme:
  name: 'material'
  features:
    - navigation.expand
  palette:
    primary: white
    accent: blue grey
  logo: ./images/codalab-logo.png
  favicon: ./images/favicon.ico

extra_css:
  - main.css

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - toc:
      permalink: true

repo_name: codalab/codalab-worksheets
repo_url: https://github.com/codalab/codalab-worksheets

nav:
  - Introduction: index.md
  - Examples:
      - Quickstart: examples/quickstart.md
  - Features:
    - Bundles:
      - Uploading and Downloading Bundles: features/bundles/uploading.md
  - Concepts:
    - The CodaLab Workflow: Workflow.md
    - Executable Papers: Executable-Papers.md
    - Worksheet Markdown: Worksheet-Markdown.md
    - Execution: Execution.md
    - Competitions: Competitions.md
    - Storage Externalization: Externalization.md
    - Checkpoints: Checkpoints.md
    - Lifecycle of a Bundle: Bundle-Lifecycle.md
  - Reference:
    - CLI Reference: CLI-Reference.md
    - REST API Reference: REST-API-Reference.md
  - Contributing:
    - Code Overview: Code-Overview.md
    - Server Setup: Server-Setup.md
    - Worker Managers: Worker-Managers.md
    - Multiple Bundle Stores (in development): Multiple-Bundle-Stores.md
    - Development Setup: Development-Setup.md
  - About:
    - About: About.md
    - Privacy: Privacy.md
    - Frequently Asked Questions: FAQ.md
  - Blog:
      - Fall 2020: blog/2020-fall.md