hype/mkdocs.yml at master · riyuzenn/hype · 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
site_name: Hype
site_description: A lightweight command line interface toolkit for python
site_url: https://hype.serum.studio

repo_name: serumstudio/hype
repo_url: https://github.com/serumstudio/hype

copyright: Copyright &copy; 2020 - 2021, Serum Studio

theme:

  name: material
  palette:
    - scheme: default
      accent: purple
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    - scheme: slate
      primary: grey
      accent: purple
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

  logo: assets/hypecli.svg
  favicon: assets/favicon.ico

  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - navigation.sections

  plugins:
    - search
    - tags

nav:
  - Getting started:
    - index.md
    - Installation: getting-started.md
    - Features: features.md

  - Commands:
    - commands/index.md
    - Handling Commands: commands/handling-commands.md
    - Running The Commands: commands/running.md

  - Plugins:
    - plugins/index.md
    - Handling Colors: plugins/colors.md

  - Examples:
    - examples/index.md
    - With Colors: examples/with-colors.md

  - Development:
    - development/index.md
    - Contributing Policy: development/contributing.md
    - Code of Conduct: development/code-of-conduct.md
    - Contributors: development/contributors.md
    - Release Notes: development/release-notes.md


extra_css:
  - assets/css/termynal.css
  - assets/css/style.css

extra_javascript:
  - assets/js/termynal.js
  - assets/js/custom.js


markdown_extensions:
  - toc
  - admonition
  - codehilite
  - extra
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.details

extra:
    social:
        - icon: fontawesome/brands/github
          link: 'https://github.com/serumstudio/hype'
          name: Star us on GitHub

        - icon: fontawesome/brands/twitter
          link: 'https://twitter.com/serumstudio'
          name: Follow us on Twitter

        - icon: fontawesome/solid/globe
          link: 'https://serum.studio'
          name: Visit out Website