zentone/mkdocs.yml at develop · nisrulz/zentone · 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
# Project information
site_name: 'ZenTone'
site_description: 'Easily generate audio tone of a specific frequency and volume in Android.'
site_author: '2022 Nishant Srivastava'
site_url: 'https://nisrulz.com/zentone/'
remote_branch: gh-pages
edit_uri: ""

# Github Info
repo_name: 'nisrulz/zentone'
repo_url: 'https://github.com/nisrulz/zentone'

# Copyright
copyright: 'Copyright &copy; 2022 Nishant Srivastava'

# Configuration
theme:
  name: 'material'
  language: 'en'
  favicon: 'img/favicon.ico'
  logo: 'img/logo.png'
  icon:
    repo: 'fontawesome/brands/github'
  palette:
    primary: 'deep purple'
    accent: 'white'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'

# Navigation
nav:
  - 'Overview': index.md
  - 'Integration': integration.md
  - 'Usage': usage.md
  - 'API ⏏': api/index.html
  - 'Change Log': changelog.md

# Extensions
markdown_extensions:
  - admonition
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

# Plugins
plugins:
  - search

# Extras
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/nisrulz
    - icon: fontawesome/brands/github
      link: https://github.com/nisrulz

# Built with https://github.com/squidfunk/mkdocs-material