mkdocs.yml

---
copyright: Copyleft © 2017 - 5ever WOAHBase

draft_docs: |
  *_draft.md
exclude_docs: |
  *_draft.md
  *_exclude.md

extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

  homepage: https://woahbase.online
  mailto: write@woahbase.online

  orgname: &orgname woahbase
  dockrepo: https://hub.docker.com/r/woahbase/
  twiturl: &twiturl https://x.com/woahbase

  sources:
    github:
      name: Github
      orgurl: &gitorg https://github.com/woahbase
      cloneurl: https://github.com  # /orgname/os-app
      weburl: https://github.com  # /orgname/os-app
    # # add your self-hosted git repository below
    private:
      disabled: true
      name: Your Private Git
      orgurl: https://git.service.local/git/woahbase
      cloneurl: ssh://git@git.service.local:64822/~git/repositories  # /orgname/os-app
      weburl: https://git.service.local/git  # /orgname/os-app

  distributions:
    dockerhub:
      name: Docker Hub
      # ns: docker.io
      orgurl: &dockorg https://hub.docker.com/u/woahbase
      weburl: https://hub.docker.com/r  # /orgname/os-app
    # ghcr:
    #   # disabled: true
    #   name: GHCR.io
    #   ns: ghcr.io
    #   orgurl: https://github.com/woahbase
    #   weburl: https://github.com  # /orgname/os-app
    # # add your self-hosted image repository below
    private:
      disabled: true
      name: Your Private Registry
      ns: registry.service.local
      orgurl: https://registry.service.local/ui
      weburl: 'https://registry.service.local/ui/#!/taglist'  # /orgname/os-app

  social:
    - icon: fontawesome/brands/github
      link: *gitorg
    # - icon: fontawesome/brands/gitter
    #   link: https://gitter.im/<username>/<project-name>
    - icon: fontawesome/brands/docker
      link: *dockorg
    - icon: fontawesome/brands/twitter
      link: *twiturl
    # - icon: fontawesome/brands/linkedin
    #   link: https://linkedin.com/in/<username>
    # - icon: fontawesome/brands/instagram
    #   link: https://instagram.com/<username>

  # extra vars for macros
  # alpine stable version for generating package urls
  alpine_branch: v3.21
  # default supported architecture-tags
  arches: [aarch64, armhf, armv7l, x86_64]
  platforms: # maps architecture-tags to docker image platforms
    aarch64: --os linux --arch arm64
    armhf: --os linux --arch arm --variant v6
    armv7l: --os linux --arch arm --variant v7
    i386: --os linux --arch 386
    loong64: --os linux --arch loong64
    mips64: --os linux --arch mips64
    mips64le: --os linux --arch mips64le
    ppc64le: --os linux --arch ppc64le
    riscv64: --os linux --arch riscv64
    s390x: --os linux --arch s390x
    x86_64: --os linux --arch amd64
  shieldparams: >-
    color=brightgreen&style=flat-square
  # pgid: "`id -g`"
  # puid: "`id -u`"

extra_css:
  - assets/css/fonts.css
    # fonts source: https://gwfh.mranftl.com/
  - assets/css/extra.css
extra_javascript:
  - assets/js/extra.js

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      # auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: *orgname
      repo: website
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: [snippets/]
      check_paths: false
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md

  - Images:
      - Our Images: images/index.md

      # - base:
      # --------
      - alpine-base: images/alpine-base.md
      - alpine-s6: images/alpine-s6.md
      - alpine-glibc: images/alpine-glibc.md
      - alpine-supervisor: images/alpine-supervisor.md

      # - dev/runtime:
      # --------
      - alpine-go: images/alpine-go.md
      - alpine-lua: images/alpine-lua.md
      - alpine-nodejs: images/alpine-nodejs.md
      - alpine-openjdk8: images/alpine-openjdk8.md
      - alpine-openjdk11: images/alpine-openjdk11.md
      - alpine-openjdk17: images/alpine-openjdk17.md
      - alpine-openjdk21: images/alpine-openjdk21.md
      - alpine-php: images/alpine-php.md
      - alpine-python3: images/alpine-python3.md
      - alpine-ruby: images/alpine-ruby.md

      # - service
      # --------
      - alpine-adminer: images/alpine-adminer.md
      - alpine-apcupsd: images/alpine-apcupsd.md
      - alpine-blocky: images/alpine-blocky.md
      - alpine-buildmaster: images/alpine-buildmaster.md
      - alpine-buildworker: images/alpine-buildworker.md
      - alpine-cec: images/alpine-cec.md
      - alpine-cgit: images/alpine-cgit.md
      - alpine-chronograf: images/alpine-chronograf.md
      - alpine-consul: images/alpine-consul.md
      - alpine-coturn: images/alpine-coturn.md
      - alpine-davical: images/alpine-davical.md
      - alpine-dhcp: images/alpine-dhcp.md
      - alpine-gotify: images/alpine-gotify.md
      - alpine-grafana: images/alpine-grafana.md
      - alpine-haproxy: images/alpine-haproxy.md
      - alpine-influxdb: images/alpine-influxdb.md
      - alpine-jackett: images/alpine-jackett.md
      - alpine-kanboard: images/alpine-kanboard.md
      - alpine-kapacitor: images/alpine-kapacitor.md
      - alpine-mjpgstreamer: images/alpine-mjpgstreamer.md
      - alpine-mosquitto: images/alpine-mosquitto.md
      - alpine-mpd: images/alpine-mpd.md
      - alpine-mysql: images/alpine-mysql.md
      - alpine-navidrome: images/alpine-navidrome.md
      - alpine-nfs: images/alpine-nfs.md
      - alpine-nginx: images/alpine-nginx.md
      - alpine-pigpio: images/alpine-pigpio.md
      - alpine-postgresql: images/alpine-postgresql.md
      - alpine-redis: images/alpine-redis.md
      - alpine-rediscommander: images/alpine-rediscommander.md
      - alpine-registry: images/alpine-registry.md
      - alpine-rsyncd: images/alpine-rsyncd.md
      - alpine-rsyslog: images/alpine-rsyslog.md
      - alpine-saned: images/alpine-saned.md
      - alpine-squid: images/alpine-squid.md
      - alpine-ssh: images/alpine-ssh.md
      - alpine-sshwifty: images/alpine-sshwifty.md
      - alpine-syncthing: images/alpine-syncthing.md
      - alpine-tftp: images/alpine-tftp.md
      - alpine-transmission: images/alpine-transmission.md
      - alpine-ttrss: images/alpine-ttrss.md
      - alpine-ubooquity: images/alpine-ubooquity.md
      - alpine-uptimekuma: images/alpine-uptimekuma.md
      - alpine-vault: images/alpine-vault.md
      - alpine-wallabag: images/alpine-wallabag.md
      - alpine-webhook: images/alpine-webhook.md

      # - usershell
      # --------
      - alpine-ansible: images/alpine-ansible.md
      - alpine-awscli: images/alpine-awscli.md
      - alpine-chromium: images/alpine-chromium.md
      - alpine-dood: images/alpine-dood.md
      - alpine-firefox: images/alpine-firefox.md
      - alpine-gimp: images/alpine-gimp.md
      - alpine-hugo: images/alpine-hugo.md
      - alpine-mkdocsmaterial: images/alpine-mkdocsmaterial.md
      - alpine-libreoffice: images/alpine-libreoffice.md
      - alpine-maven: images/alpine-maven.md
      - alpine-rclone: images/alpine-rclone.md
      - alpine-rpigpio: images/alpine-rpigpio.md
      - alpine-snapraid: images/alpine-snapraid.md
      - alpine-watchtower: images/alpine-watchtower.md
      - alpine-weechat: images/alpine-weechat.md

      # - Legacy: []

      # - services
      # --------
      - alpine-activemq: images/alpine-activemq.md
      - alpine-jenkins: images/alpine-jenkins.md
      - alpine-pulseaudio: images/alpine-pulseaudio.md
      - alpine-searx: images/alpine-searx.md

      # - usershell
      # --------
      - alpine-ionic: images/alpine-ionic.md
      - alpine-ng: images/alpine-ng.md
      - alpine-quasar: images/alpine-quasar.md
      - alpine-tomcat: images/alpine-tomcat.md
      - alpine-vue: images/alpine-vue.md

      # - Deprecated:

      # - dev/runtime
      # --------
      - alpine-openjdk7: images/alpine-openjdk7.md
      - alpine-openjdk14: images/alpine-openjdk14.md
      - alpine-python2: images/alpine-python2.md

      # - services
      # --------
      - alpine-blynk: images/alpine-blynk.md
      - alpine-laverna: images/alpine-laverna.md
      - alpine-libresonic: images/alpine-libresonic.md
      - alpine-lychee: images/alpine-lychee.md
      - alpine-netdata: images/alpine-netdata.md
      - alpine-pdnsd: images/alpine-pdnsd.md
      - alpine-pydio: images/alpine-pydio.md
      - alpine-wildfly: images/alpine-wildfly.md

      # - usershell
      # --------
      - alpine-android: images/alpine-android.md
      - alpine-github: images/alpine-github.md
      - alpine-travis: images/alpine-travis.md
      - alpine-youtubedl: images/alpine-youtubedl.md

      - Their Images:
        - binfmt: images/binfmt.md
        - buildkit: images/buildkit.md
        - qemu-user-static: images/qemu-user-static.md

  - About:
      - About: about/index.md
      - Contact: about/contact.md
      - Donate: about/donate.md

  - Contact: /about/contact
  - Donate: /about/donate

plugins:
  - git-authors
  - git-revision-date-localized:
      type: timeago
      enable_creation_date: false
      fallback_to_build_date: true
  - macros:
      include_dir: snippets
      on_error_fail: !ENV [MACRO_ERROR_FAIL, false]
  # - meta-descriptions
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      js_files:
        - assets/js/extra.js
      css_files:
        - assets/css/fonts.css
        - assets/css/extra.css
  - redirects:
      redirect_maps: {}
  - search:
      lang: en
      pipeline:
        - stemmer
        - stopWordFilter
        - trimmer
      # indexing: titles
  # - social:
  #     cache_dir: .cache/plugin/social
  - tags:
      # tags_file: images/index.md

repo_name: woahbase/website
repo_url: https://github.com/woahbase/website
# edit_uri: https://github.com/woahbase/website/edit/master/docs

site_name: WOAHBase
site_url: https://woahbase.online/
site_author: lapnapra
site_description: >-
  Where only Awesome happens,
  works only at Home.

theme:
  name: material
  custom_dir: overrides

  favicon: assets/images/favicon.ico
  font:
    text: Roboto
    code: Roboto Mono
  language: en
  logo: assets/images/logo.png
  static_templates:
    - 404.html  # 404 page

  include_search_page: false
  search_index_only: true

  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    # - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    # - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

  icon:
    admonition:
      tip: material/hand-coin

    repo: simple/github
    tag:
      default: fontawesome/solid/hashtag

  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: white
      accent: light green
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

use_directory_urls: true

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

watch:
  - snippets