mkdocs-internal.yml

site_name: Rummage
site_url: 'file://.'
edit_uri: tree/master/docs/src/markdown
site_description: A search and replace tool written in Python.

use_directory_urls: false

docs_dir: docs/src/markdown
theme:
  name: null
  custom_dir: docs/internal_theme
  static_templates:
    - 404.html
    - sitemap.html
  include_search_page: false
  search_index_only: true

plugins: []

nav:
  - Rummage: index.md
  - Installation: installation.md
  - Basic Usage: usage.md
  - Search Features: search.md
  - Settings: preferences.md
  - Extras: extras.md
  - Contributing & Support: about/contributing.md

markdown_extensions:
  - markdown.extensions.toc:
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - markdown.extensions.smarty:
      smart_quotes: false
  - pymdownx.betterem:
  - markdown.extensions.attr_list:
  - markdown.extensions.tables:
  - markdown.extensions.abbr:
  - markdown.extensions.footnotes:
  - markdown.extensions.md_in_html:
  - pymdownx.superfences:
  - pymdownx.highlight:
      extend_pygments_lang:
        - name: pycon3
          lang: pycon
          options:
            python3: true
  - pymdownx.inlinehilite:
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      user: facelessuser
      repo: Rummage
  - pymdownx.tilde:
  - pymdownx.caret:
  - pymdownx.smartsymbols:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.escapeall:
      hardbreak: True
      nbsp: True
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.striphtml:
  - pymdownx.snippets:
      base_path:
      - docs/src/markdown/.snippets
      - LICENSE.md
      auto_append:
      - refs.md
  - pymdownx.keys:
      separator: "\uff0b"
  - pymdownx.blocks.admonition:
      types:
      - new
      - settings
      - note
      - abstract
      - info
      - tip
      - success
      - question
      - warning
      - failure
      - danger
      - bug
      - example
      - quote
  - pymdownx.blocks.html:
  - pymdownx.blocks.definition:
  - pymdownx.fancylists:
      inject_style: true