5-72

5-72.com helps novice musicians master sound engineering by analyzing the FX chains of world-famous artists
Log | Files | Refs

mkdocs.yml (4126B)


      1 # Project information
      2 site_name: 5FA-72-EVG
      3 site_url: https://5-72.com/
      4 site_author: Ismail Dalgatov
      5 site_description: >-
      6   5-72 is an open-source documentation from sound-engineers and musicians.
      7 # Repository
      8 repo_name: ismaildalgatov/5-72
      9 repo_url: https://github.com/ismaildalgatov/5-72
     10 
     11 # Copyright
     12 copyright: Copyright © 2020 - 2023 Ismail Dalgatov
     13 
     14 # Configuration
     15 theme:
     16   name: null
     17   custom_dir: !ENV [THEME_DIR, "material"]
     18 
     19   # Static files
     20   static_templates:
     21     - 404.html
     22 
     23   # Don't include MkDocs' JavaScript
     24   include_search_page: false
     25   search_index_only: true
     26 
     27   # Default values, taken from mkdocs_theme.yml
     28   language: en
     29   features:
     30     # - announce.dismiss
     31     - content.code.annotate
     32     # - content.tabs.link
     33     - content.tooltips
     34     - header.autohide
     35     # - navigation.expand
     36     - navigation.indexes
     37     - navigation.instant
     38     # - navigation.prune
     39     - navigation.sections
     40     - navigation.tabs
     41     # - navigation.tabs.sticky
     42     - navigation.top
     43     - navigation.tracking
     44     - search.highlight
     45     - search.share
     46     - search.suggest
     47     - toc.follow
     48     # - toc.integrate
     49   palette:
     50     - scheme: default
     51       primary: indigo
     52       accent: indigo
     53       toggle:
     54         icon: material/toggle-switch-off-outline
     55         name: Switch to dark mode
     56     - scheme: slate
     57       primary: indigo
     58       accent: indigo
     59       toggle:
     60         icon: material/toggle-switch
     61         name: Switch to light mode
     62   font:
     63     text: Roboto
     64     code: Roboto Mono
     65   favicon: assets/favicon.png
     66   icon:
     67     logo: logo
     68 
     69 # Plugins
     70 plugins:
     71   - git-revision-date-localized
     72   - search
     73 #  - redirects:
     74 #      redirect_maps:
     75 #        changelog/insiders.md: insiders/changelog.md
     76 #        conventions.md: philosophy.md
     77 #        reference/abbreviations.md: reference/tooltips.md
     78 #        reference/meta-tags.md: reference/index.md
     79 #        reference/variables.md: https://mkdocs-macros-plugin.readthedocs.io/
     80 #        sponsorship.md: insiders/index.md
     81 #        upgrading.md: upgrade.md
     82   - minify:
     83       minify_html: true
     84 
     85 # Customization
     86 extra:
     87   analytics:
     88     provider: google
     89     property: !ENV GOOGLE_ANALYTICS_KEY
     90   social:
     91     - icon: fontawesome/brands/telegram
     92       link: https://t.me/s/teamseshisma
     93     - icon: fontawesome/brands/twitter
     94       link: https://twitter.com/teamseshisma
     95     - icon: fontawesome/brands/instagram
     96       link: https://instagram.com/teamseshisma
     97 
     98 # Extensions
     99 markdown_extensions:
    100   - admonition
    101   - abbr
    102   - attr_list
    103   - def_list
    104   - footnotes
    105   - meta
    106   - md_in_html
    107   - pymdownx.snippets
    108   - toc:
    109       permalink: true
    110   - pymdownx.arithmatex:
    111       generic: true
    112   - pymdownx.betterem:
    113       smart_enable: all
    114   - pymdownx.caret
    115   - pymdownx.details
    116   #  - pymdownx.emoji:
    117   #      emoji_generator: !!python/name:materialx.emoji.to_svg
    118   #      emoji_index: !!python/name:materialx.emoji.twemoji
    119   - pymdownx.highlight:
    120       anchor_linenums: true
    121   - pymdownx.inlinehilite
    122   - pymdownx.keys
    123   - pymdownx.magiclink:
    124       repo_url_shorthand: true
    125       user: ismaildalgatov
    126       repo: 5-72
    127   - pymdownx.mark
    128   - pymdownx.smartsymbols
    129   - pymdownx.superfences:
    130       custom_fences:
    131         - name: mermaid
    132           class: mermaid
    133           format: !!python/name:pymdownx.superfences.fence_code_format
    134   - pymdownx.tabbed:
    135       alternate_style: true
    136   - pymdownx.tasklist:
    137       custom_checkbox: true
    138   - pymdownx.tilde
    139 
    140 # Page tree
    141 nav:
    142   - Chains:
    143       - How it works: index.md
    144       - Zola Jesus - Exhumed: zola-jesus-exhumed.md
    145       - Arigto - Threat that lies in despair: arigto-threat-that-lies-in-despair.md
    146       - Adele - Rolling In The Deep: adele-rolling-in-the-deep.md
    147       - slowthai - feel away: slowthai-feel-away.md
    148       - Jeff Buckley - Hallelujah: jeff-buckley-hallelujah.md
    149       - The Monuments, Mick Gordon - Lavos: monuments-mick-gordon-lavos.md
    150       - Kendrick Lamar, SZA - All The Stars: kendrick-lamar-sza-all-the-stars.md
    151       - Twenty One Pilots - Chlorine: twenty-one-pilots-chlorine.md
    152       - The Weeknd - Alone Again: the-weeknd-alone-again.md
    153       - Other:
    154           - Drum Machines: drum-machines/list.md
    155   - What's new?: changelog.md