mkdocs.yml

# https://www.mkdocs.org/user-guide/configuration/
# https://www.mkdocs.org/user-guide/writing-your-docs/
# https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/writing-your-docs/
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/styling-your-docs/
# https://example-mkdocs-basic.readthedocs.io/en/latest/
# https://github.com/mkdocs/mkdocs/blob/master/mkdocs.yml
# https://squidfunk.github.io/mkdocs-material/creating-your-site/
# mkdocs.yml

site_name: pwshEmojiExplorer
# site_url:
repo_url: https://github.com/techthoughts2/pwshEmojiExplorer
# repo_name:
# edit_uri: edit/main/docs/
# edit_uri_template:
site_description: Explore the latest Unicode emojis directly in PowerShell with pwshEmojiExplorer. Search, retrieve, and integrate emojis into scripts and projects using this PowerShell module command-line toolkit. # meta tag to the generated HTML header
site_author: Jake Morrison # meta tag to the generated HTML header
copyright: "pwshEmojiExplorer is licensed under the <a href='https://github.com/techthoughts2/pwshEmojiExplorer/blob/main/LICENSE'>MIT license"
# remote_branch:
# remote_name:
# docs_dir: docs
# site_dir:
# extra_css:
# extra_javascript:
# markdown_extensions:
  # Python Markdown
  # - admonition
  # - toc:
  #     permalink: true
  # code highlighting
  # - pymdownx.highlight:
  #     use_pygments: true
  # - pymdownx.highlight:
  #     anchor_linenums: true
  # - pymdownx.inlinehilite
  # - pymdownx.snippets
  # - pymdownx.superfences

# extra_templates:
# extra:
theme:
  name: material
  language: en
  # custom_dir: overrides
  features:
    # - navigation.tabs
    # - navigation.tabs.sticky
    # - navigation.path
  favicon: assets/pwshEmojiExplorer_favicon_32x32.png
  # icon:
  #   repo:
  # font:
  #   text: Work Sans
  logo: assets/pwshEmojiExplorer_icon.png
  # palette:
  #   primary: teal
  # palette:
  #   # Palette toggle for light mode
  #   - media: "(prefers-color-scheme: light)"
  #     scheme: default
  #     primary: light blue
  #     accent: pink
  #     toggle:
  #       icon: material/brightness-7
  #       name: Switch to dark mode

    # # Palette toggle for dark mode
    # - media: "(prefers-color-scheme: dark)"
    #   scheme: slate
    #   primary: indigo
    #   accent: pink
    #   toggle:
    #     icon: material/brightness-4
    #     name: Switch to light mode
nav:
  - Home: index.md
  - Usage:
    - pwshEmojiExplorer Basics: pwshEmojiExplorer-Basics.md
  - Functions:
    - Add-EmojiToText: Add-EmojiToText.md
    - Get-AllEmoji: Get-AllEmoji.md
    - Get-Emoji: Get-Emoji.md
  - Metrics: pwshEmojiExplorer-Metrics.md
  - FAQ: pwshEmojiExplorer-FAQ.md
  - Data Set Creation: pwshEmojiExplorer_data_workflow.md
  - Change Log: CHANGELOG.md