docs/mkdocs.yml at master · myfirebase/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
site_name: Myfirebase docs

# Configuration
theme:
  name: null
  custom_dir: mkdocs-material/material
  favicon: 'assets/images/favicon.png'

  # 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: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  logo: 'images/MyFireBase.svg'

repo_name: myfirebase/myfirebase
repo_url: https://github.com/myfirebase/myfirebase

pages:

- Welcome: index.md

- Getting Started:
    - 'Installation': 'installation.md'
    - 'Directory Structure': 'directory-structure.md'

- The Basics:
    - "Components": 'components.md'
    - "Routing": 'routing.md'
    - "State Managment System": 'store.md'

- Database:
    - "Realtime Database and Cloud Firestore": 'database.md'

- Managing SCSS/SASS:
    - 'Material design and SASS/SCSS': 'style.md'

- Functionalities:
    - 'Authentication': 'authentication.md'
    - 'Cloud Storage': 'storage.md'
    - 'Cloud Functions': 'cloud-functions.md'
    - 'Cloud Messaging': 'cloud-messaging.md'

- Deep Dive:
    - 'Middlewares (Global Navigation guards)': 'global-guard.md'
    - 'Firebase Admin (Feature request)': 'admin.md'

markdown_extensions:
  - admonition
  - codehilite(guess_lang=false)
  - toc(permalink=true)


extra:
  logo: 'img/MyFireBase.png'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'