mkdocs-blog.yml

site_name: The Python Package Index Blog
site_description: The official blog of the Python Package Index
docs_dir: blog
exclude_docs:
  README.md
site_dir: blog-site
theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.ico
  homepage: https://pypi.org
  custom_dir: blog/overrides
  palette:
    - scheme: pypi
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-night
        name: Switch to Dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-sunny
        name: Switch to Light mode
  features:
    - navigation.expand
    - navigation.top
    - navigation.footer
markdown_extensions:
  - footnotes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - abbr
  - attr_list
  - md_in_html
extra_css:
  - stylesheets/extra.css
plugins:
  - social
  # See https://squidfunk.github.io/mkdocs-material/plugins/blog/
  - blog:
      blog_dir: .
      blog_toc: true
      # Use a custom pagination URL format to avoid ReadTheDocs built-in
      # redirection, which removes the word `page` from the URL.
      # Ref: https://docs.readthedocs.io/en/stable/user-defined-redirects.html#page-redirects-at-page
      pagination_url_format: "pages/{page}"
      post_excerpt: required
      # Preserve backwards compatibility with older URLs.
      # If we ever want to change the format and thus break old URLs,
      # consider https://github.com/mkdocs/mkdocs-redirects
      post_url_format: "posts/{file}"
  - rss:
      abstract_chars_count: -1
      categories:
        - tags
      date_from_meta:
        as_creation: "date"
        as_update: "False"
        datetime_format: "%Y-%m-%d %H:%M"
        default_timezone: "UTC"
        default_time: "06:09"
      enabled: true
      image: https://blog.pypi.org/assets/logo.png
      length: 20
      match_path: "posts/.*"
  - search
  - tags:
      tags_file: tags.md
extra:
  homepage: https://pypi.org
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pypi
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@pypi
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/pypi.org
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/pypi
    - icon: material/rss
      link: https://blog.pypi.org/feed_rss_created.xml
  # See https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/
  analytics:
    provider: google
    property: G-4L9L0H79CY

site_url: https://blog.pypi.org/
repo_url: https://github.com/pypi/warehouse