nrf52-u2f/mkdocs.yml at master · makerdiary/nrf52-u2f · 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

# Project information
site_name: nRF52 FIDO U2F Security Key
site_description: An Open-Source FIDO U2F implementation on nRF52 SoC
site_author: makerdiary
site_url: https://wiki.makerdiary.com/nrf52-u2f/

# Repository
repo_name: nrf52-u2f
repo_url: https://github.com/makerdiary/nrf52-u2f
edit_uri: "https://github.com/makerdiary/nrf52-u2f/docs"

# Copyright
copyright: 'Copyright &copy; 2018 <a href="https://makerdiary.com">makerdiary</a>'

# Configuration
theme:
  name: null
  custom_dir: 'material'

  # 404 page
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  feature:
    tabs: true
  palette:
    primary: marsala
    accent: marsala
  font:
    text: Roboto
    code: Roboto Mono
  favicon: 'images/favicon.png'
  logo: 'images/logo.svg'

# Customization
extra:
  social:
    - type: comments
      link: https://community.makerdiary.com
    - type: globe
      link: https://makerdiary.com
    - type: github-alt
      link: https://github.com/makerdiary
    - type: twitter
      link: https://twitter.com/makerdiary
    - type: facebook
      link: https://www.facebook.com/makerdiary
#  disqus: 'makerdiary'
#  discourse: 'community.makerdiary.com'

# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
pages:
  - Introduction: index.md
  - Getting Started: getting-started/index.md
  - Upgrading Firmware : upgrading/index.md
  - Building the Firmware: building/index.md
  - Contributing: CONTRIBUTING.md
  - License: LICENSE.md
  - User Guides:
    - Using nRF52-U2F with Google: guides/using-u2f-with-google.md
    - Using nRF52-U2F with Facebook: guides/using-u2f-with-facebook.md
    - Using nRF52-U2F with Twitter: guides/using-u2f-with-twitter.md
    - Using nRF52-U2F with GitHub: guides/using-u2f-with-github.md
    - Using nRF52-U2F with GitLab: guides/using-u2f-with-gitlab.md


# Google Analytics
google_analytics:
  - 'UA-54344624-2'
  - 'auto'