github.com/purpleclay/gitz@v0.8.2-0.20240515052600-43f80eea2fe1/mkdocs.yml (about)

     1  site_name: Gitz
     2  site_description: Write fluent interactions to Git using the gitz library. Programmatically crafting git commands becomes a breeze!
     3  copyright: Building tools to make developers' lives easier
     4  repo_name: purpleclay/gitz
     5  repo_url: https://github.com/purpleclay/gitz
     6  # Only set during a release to ensure htmltest doesn't break due to non existent directories
     7  site_url: ""
     8  edit_uri: ""
     9  
    10  theme:
    11    name: material
    12    custom_dir: docs/overrides
    13    logo: static/logo.png
    14    favicon: static/favicon.ico
    15    palette:
    16      primary: deep purple
    17      accent: purple
    18    features:
    19      - announce.dismiss
    20      - content.code.annotate
    21      - content.code.copy
    22      - content.code.select
    23      - content.tooltips
    24      - navigation.indexes
    25      - navigation.sections
    26      - navigation.tabs
    27      - navigation.top
    28      - navigation.tracking
    29      - search.highlight
    30      - search.share
    31      - search.suggest
    32      - toc.follow
    33    icon:
    34      repo: fontawesome/brands/github
    35    font:
    36      text: Roboto
    37      code: Roboto Mono
    38  
    39  extra_css:
    40    - stylesheets/extra.css
    41  
    42  nav:
    43    - Home: index.md
    44    - Getting Started:
    45        - Git Checks: git/checks.md
    46        - Git Clone: git/clone.md
    47        - Git Commit: git/commit.md
    48        - Git Config: git/config.md
    49        - Git Checkout: git/checkout.md
    50        - Git Fetch: git/fetch.md
    51        - Git Pull: git/pull.md
    52        - Git Push: git/push.md
    53        - Git Show: git/show.md
    54        - Git Stage: git/stage.md
    55        - Git Status: git/status.md
    56        - Git Tag: git/tag.md
    57        - Git Log: git/log.md
    58        - Testing Framework:
    59            - Git Test: testing/git-test.md
    60        - Installation:
    61            - Package: install/package.md
    62        - Other Bits:
    63            - License: license.md
    64  
    65  extra:
    66    social:
    67      - icon: fontawesome/brands/github
    68        link: https://github.com/purpleclay
    69        name: Purple Clay on GitHub
    70      - icon: fontawesome/brands/twitter
    71        link: https://twitter.com/purpleclaydev
    72        name: Purple Clay on Twitter
    73      - icon: fontawesome/brands/mastodon
    74        link: https://fosstodon.org/@purpleclaydev
    75        name: Purple Clay on Fosstodon
    76      - icon: fontawesome/brands/docker
    77        link: https://hub.docker.com/u/purpleclay
    78        name: Purple Clay on Docker Hub
    79      - icon: fontawesome/brands/golang
    80        link: https://pkg.go.dev/github.com/purpleclay/gitz
    81        name: Gitz GoDocs
    82    status:
    83      new: New Features Added
    84      deprecated: No Longer Supported
    85  
    86  plugins:
    87    - git-revision-date-localized:
    88        enabled: !ENV [CI, false]
    89        enable_creation_date: true
    90        type: timeago
    91    - git-committers:
    92        enabled: !ENV [CI, false]
    93        repository: purpleclay/gitz
    94        branch: main
    95    - minify:
    96        enabled: !ENV [CI, false]
    97        minify_html: true
    98    - search
    99    - social
   100    - typeset
   101  
   102  markdown_extensions:
   103    - abbr
   104    - admonition
   105    - attr_list
   106    - def_list
   107    - footnotes
   108    - pymdownx.betterem:
   109        smart_enable: all
   110    - pymdownx.caret
   111    - pymdownx.critic
   112    - pymdownx.details
   113    - pymdownx.emoji:
   114        emoji_index: !!python/name:materialx.emoji.twemoji
   115        emoji_generator: !!python/name:materialx.emoji.to_svg
   116    - pymdownx.highlight:
   117        anchor_linenums: true
   118        line_spans: __span
   119        pygments_lang_class: true
   120    - pymdownx.inlinehilite
   121    - pymdownx.mark
   122    - pymdownx.snippets
   123    - pymdownx.superfences
   124    - pymdownx.tabbed:
   125        alternate_style: true
   126    - pymdownx.tilde
   127    - md_in_html
   128    - meta
   129    - toc:
   130        permalink: true