mkdocs.yml

# Replace XXX with the network's name
'site_name': 'Pepe Docs'
'site_url': 'https://papermoonio.github.io/demo-docs/'
'docs_dir': 'pepe-docs'
'copyright': '© 2024 Pepe Foundation. All Rights Reserved.'
# Used for extra javascript files in the `docs` repository
# 'extra_javascript':
#   - 'js/externalLinkModal.js' # Enable if you want a warning when users leave your site
#   - 'https://widget.kapa.ai/kapa-widget.bundle.js' # Enable is project is using Kapa
#   - 'js/initKapaWidget.js' # Enable if project is using Kapa
# Used for additional CSS files and custom fonts. If you're using a publicly available font, this is not necessary
'extra_css':
  - 'assets/stylesheets/extra.css'
  - 'assets/stylesheets/terminal.css'
'theme':
  'name': 'material'
  'custom_dir': 'material-overrides'
  'favicon': 'assets/images/pepe-favicon.png'
  'logo': 'assets/images/pepe-logo.png'
  'logo_dark_mode': 'assets/images/pepe-logo-dark.png' # Only required if using dark and light modes  #'font': # This is for Google Fonts
    #'text': 'XXX' # Add the name of the font. The default is Roboto
    #'code': 'XXX' # This is optional. The default is Roboto Mono
  'features':
    - 'content.code.annotate' # Adds annotations to code blocks
    - 'content.code.copy' # Adds copy to clipboard button to code snippets
    - 'content.tooltips' # Adds tooltips
    - 'navigation.footer' # Shows previous and next on the footer
    - 'navigation.tabs' # Top-level sections are rendered below the header (can be modified to in-line with CSS)
    - 'navigation.tabs.sticky' # When scrolling, the tabs remain at the top of the page
    - 'navigation.sections' # Render top-level sections as groups in the sidebar
    - 'navigation.indexes' # Index pages
  # Used for light and dark mode feature
  'palette':
    # Palette toggle for light mode
    - 'media': "(prefers-color-scheme: light)"
      'scheme': default
      'toggle':
        'icon': material/weather-night
        'name': Switch to dark mode
    # Palette toggle for dark mode
    - 'media': "(prefers-color-scheme: dark)"
      'scheme': slate
      'toggle':
        'icon': material/weather-sunny
        'name': Switch to light mode
'markdown_extensions':
  - 'abbr'
  - 'admonition'
  - 'attr_list'
  - 'codehilite'
  - 'md_in_html'
  - 'meta' 
  - 'pymdownx.details'
  - 'pymdownx.emoji':
      'emoji_index': !!python/name:material.extensions.emoji.twemoji
      'emoji_generator': !!python/name:material.extensions.emoji.to_svg
  - 'pymdownx.highlight':
      'anchor_linenums': !!bool 'true'
      'line_spans': __span
      'pygments_lang_class': !!bool 'true'
  - pymdownx.inlinehilite
  - pymdownx.keys
  - 'pymdownx.snippets':
      'base_path': 'pepe-docs/.snippets'
      'url_download': !!bool 'true'
  - 'pymdownx.superfences'
  - 'pymdownx.tabbed':
      'alternate_style': !!bool 'true'
  - 'toc':
      'title': 'Sections'
'plugins':
  - 'search'
  - 'awesome-pages'
  - 'git-revision-date-localized':
      'enabled': !ENV [ENABLED_GIT_REVISION_DATE, True]
      'enable_creation_date': !!bool 'true'
  - 'redirects':
      'redirect_maps':
        # Redirects will go here as pages get moved around in the following format:
        # 'old-page.md': 'new-page.md'
  - 'macros':
      'include_yaml':
        - 'pepe-docs/variables.yml'
'extra':
  'generator': !!bool 'false'
  'social':
    - 'icon': 'fontawesome/brands/discord'
      'link': 'https://discord.gg/'
      'name': 'Discord'
    - 'icon': 'fontawesome/brands/telegram'
      'link': 'https://t.me/'
      'name': 'Telegram'
    - 'icon': 'fontawesome/brands/twitter'
      'link': 'https://twitter.com/'
      'name': 'Twitter'
    - 'icon': 'fontawesome/brands/github'
      'link': 'https://github.com/papermoonio/demo-docs'
      'name': 'GitHub'
  'analytics':
    'provider': 'google'
    'property': 'G-pepe'
    'feedback':
      'title': 'Was this page helpful?'
      'ratings':
        - 'icon': 'material/emoticon-happy-outline'
          'name': 'This page was helpful'
          'data': 1
          'note': >-
            Thanks for your feedback!
        - 'icon': 'material/emoticon-sad-outline'
          'name': 'This page could be improved'
          'data': 0
          'note': >-
            Thanks for your feedback! Help us improve this page by submitting
            <a href="https://github.com/papermoonio/demo-docs/pepe/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">additional feedback</a>.