awesome-polars/mkdocs.yml at main · ddotta/awesome-polars · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# The site is built from README.md: `.github/scripts/build_docs.py` renders it
# into docs/index.md, which is generated and gitignored. This file is not —
# edit the theme here.
#
# The three repo-dependent values default to the upstream repository and are
# overridden by the Pages workflow, so forks deploy with their own URLs.
site_name: Awesome Polars
site_description: >-
  A curated list of Polars docs, talks, tools, examples & articles
  the internet has to offer.
site_url: !ENV [SITE_URL, "https://ddotta.github.io/awesome-polars/"]
repo_url: !ENV [REPO_URL, "https://github.com/ddotta/awesome-polars"]
repo_name: !ENV [REPO_NAME, "ddotta/awesome-polars"]
# Every page comes from README.md, so pin the edit link instead of letting
# MkDocs append the (generated) page path.
edit_uri_template: edit/main/README.md
copyright: Released under CC0 1.0 Universal

theme:
  name: material
  logo: media/logo_awesome_polars.png
  favicon: media/logo_awesome_polars.png
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  # md_in_html lets the README's centred <div> wrappers keep their content.
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: !ENV [REPO_URL, "https://github.com/ddotta/awesome-polars"]
      name: Awesome Polars on GitHub
    - icon: fontawesome/solid/bolt
      link: https://pola.rs/
      name: Polars

validation:
  links:
    anchors: warn
    unrecognized_links: warn