mkdocs.yml

site_name: Crystal
site_url: https://crystal-lang.org/reference/latest/
repo_url: https://github.com/crystal-lang/crystal
edit_uri: https://github.com/crystal-lang/crystal-book/edit/master/docs/
use_directory_urls: false

extra:
  alternate:
    - name: English
      link: https://crystal-lang.org/reference/
      lang: en
    - name: 日本語
      link: https://ja.crystal-lang.org/reference/
      lang: ja
  version:
    provider: mike
  analytics:
    provider: google
    property: UA-42353458-1

theme:
  name: material
  language: en
  palette:
    primary: black
    accent: blue
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

  favicon: https://crystal-lang.org/favicon.ico
  logo: assets/crystal-circ.svg
  custom_dir: overrides
  features:
    - content.action.edit
    - navigation.footer
    - navigation.tabs

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

exclude_docs: |
  SUMMARY.md

extra_css:
  - assets/vendor/codemirror/codemirror.min.css
  - assets/style.css
  - assets/vendor/carcin-play/carcin-play.css
  - assets/vendor/carcin-play/codemirror-theme.css

plugins:
  - search
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - redirects:
      redirect_maps:
        introduction.md: README.md
        syntax_and_semantics/literals.md: syntax_and_semantics/literals/README.md
        syntax_and_semantics/macros.md: syntax_and_semantics/macros/README.md
        syntax_and_semantics/annotations.md: syntax_and_semantics/annotations/README.md
        guides/continuous_integration.md: guides/ci/README.md
        conventions/documenting_code.md: syntax_and_semantics/documenting_code.md
        overview/index.md: syntax_and_semantics/README.md
        overview/hello_world.md: getting_started/README.md
        using_the_compiler/README.md: man/crystal/README.md
        the_shards_command/README.md: man/shards/README.md
        governance.md: https://crystal-lang.org/community/governance.html
        platform_support.md: syntax_and_semantics/platform_support.md
  - code-validator:
      enabled: !ENV [LINT, false]
      identifiers:
        crystal:
          validators:
            - crystal tool format --check -
        crystal-play:
          language: crystal
          validators:
            - crystal tool format --check -
            - crystal build --no-codegen $<

hooks:
  - hooks.py

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
      base_path:
        - !relative $config_dir
  - callouts
  - toc:
      permalink: true

extra_javascript:
  - assets/vendor/codemirror/codemirror.min.js
  - assets/vendor/codemirror/mode/crystal/crystal.min.js
  - assets/vendor/carcin-play/carcin.js
  - assets/vendor/carcin-play/carcin-play.js
  - assets/vendor/ansi_up/ansi_up.min.js
  - assets/crystal-play.js