phptools-docs/mkdocs.yml at master · sandun1616/phptools-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: PHP Tools for Visual Studio - Documentation
site_author: DEVSENSE s.r.o.
site_description: This site provides DEVSENSE PHP Extension documentation.

# Repository
repo_name: DEVSENSE/phptools-docs
repo_url: https://github.com/DEVSENSE/phptools-docs

theme:
    name: material
    custom_dir: overrides
    features:
     - navigation.tabs
    #  - navigation.expand       # Expands the active navigation item
     - navigation.auto-collapse # Automatically collapses inactive items
     - navigation.tracking
     - navigation.indexes
     - navigation.top
     - toc.follow
    #  - toc.integrate
     - search.highlight
     - search.share
     - search.suggest
     - content.code.annotation
     - content.code.copy
     - content.action.edit
     - content.action.view
    language: en
    palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
    favicon: assets/images/favicon.ico
    logo_dark_mode: assets/images/logo-dark.png
    logo_light_mode: assets/images/logo.png

markdown_extensions:
- pymdownx.highlight:
    anchor_linenums: true
    guess_lang: false
    # line_spans: __span
    pygments_lang_class: true
    extend_pygments_lang:
      - name: php
        lang: php
        options:
          startinline: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- toc:
    permalink: "#"
    # markdown_extensions:
    #   # - pymdownx.highlight:
    #   #     anchor_linenums: true
    #   #     guess_lang: false        # Disables guessing the language if not specified
    #   #     code_attr_on_pre: true
    #   #     pygments_style: monokai
- admonition
#   - pymdownx.inlinehilite
#   - pymdownx.snippets
#   - pymdownx.arithmatex:
#       generic: true
#   - footnotes
#   - pymdownx.details
#   # - pymdownx.superfences
#   - pymdownx.mark
#   - attr_list
#   - pymdownx.emoji:
#       emoji_index: !!python/name:materialx.emoji.twemoji
#       emoji_generator: !!python/name:materialx.emoji.to_svg

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - js/extra.js
  # - js/theme-sync.js

exclude_docs: |
  *.es.md
  *.ja.md

plugins:
  - awesome-pages
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - mkdocs-simple-hooks:
      hooks:
        on_page_markdown: "overrides.hooks:parse_custom_meta"
        on_config: "overrides.hooks:on_config"
  - redirects:
      redirect_maps:
        vscode/editor/customize-formatting.md: vscode/formatting/customize-formatting.md
#       collapse_single_pages: true
#       strict: false
#       order: asc
#       sort_type: natural
#       order_by: title


extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devsense
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/devsense
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/user/DevsenseCorp
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/ph4vs
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/DevsenseCorp
  analytics:
    provider: google
    property: G-GD0WYQ4RWX