python/mkdocs.yml at main · blutterfly/python · 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
site_name: "Python"
site_description: "Documentation, quick reference, best practices and code. "
site_url: "https://blutterfly.github.io/python"  # Replace with your URL if desired

# -------------
# THEME
# -------------
theme:
  name: material
  # The next lines are optional; they showcase some recommended settings:
  features:
    - navigation.instant          # Dynamic navigation within a single page
    - navigation.tracking         # Tracks your scroll position
    # - toc.integrate               # Integrates ToC into the main navigation for the current page
  palette:
    # Example: lighten/darken or define your own theme colors
    - scheme: default
      primary: blue
      accent: pink
    - scheme: slate
      primary: blue
      accent: pink
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  icon:
    # Example: Use some Material icons
    logo: material/language-python
    repo: fontawesome/brands/github
  extra_css:
    - overrides/extra.css

# -------------
# NAVIGATION
# -------------
nav:
  - Home: index.md
  - Pandas: pandas/index.md
  - Examples:
      - examples/index.md
      - Data Structures: examples/data_structures.md
      - Dictionary: examples/dictionary.md
      - List Example: examples/list.md
      - File IO: examples/file_io.md
      - F Strings: examples/f_strings.md
      - Regular Expressions: examples/re.md
      - Stocks Data: examples/stocks_data.md
  - Medium Articles:
      - medium/index.md
      - Tree: medium/tree.md
  - Mkdocs: mkdocs/index.md


# -------------
# PLUGINS
# -------------
plugins:
  - search
#  - include-markdown
#  - macros
  # Material provides many additional plugins/features.
  # For dynamic Table of Contents (instant navigation), you can also add:
  #  - mkdocs-material
  # Or advanced features like:
  #  - mkdocs-awesome-pages-plugin
  #  - mkdocs-git-revision-date-localized-plugin
  # etc.

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - toc:
      permalink: true
      toc_depth: 2-4