-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
132 lines (125 loc) · 3.8 KB
/
mkdocs.yml
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# Site Information
site_name: Freenalytics
site_description: An open source, self-hosted dashboard for usage analytics of general use applications.
site_author: Freenalytics
site_url: https://freenalytics.github.io
# Repo
repo_name: freenalytics/freenalytics
repo_url: https://github.com/freenalytics/freenalytics
edit_uri: ''
# Extra
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/freenalytics
name: Freenalytics on GitHub
- icon: fontawesome/brands/docker
link: https://github.com/freenalytics/freenalytics/pkgs/container/freenalytics
name: Docker Image
- icon: fontawesome/solid/code
link: https://freenalytics.github.io/api-docs/
name: API Reference
- icon: fontawesome/brands/trello
link: https://trello.com/b/oDg8aD7n
name: Trello Board
- icon: fontawesome/brands/twitter
link: https://twitter.com/moonstar_x99
name: Twitter Profile
# Copyright
copyright: Copyright © 2022 Freenalytics
# Theme Customization
theme:
name: material
palette:
- scheme: default
primary: deep orange
accent: blue
media: "(prefers-color-scheme: light)"
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
primary: deep orange
accent: blue
media: "(prefers-color-scheme: dark)"
toggle:
icon: material/weather-night
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
icon:
repo: fontawesome/brands/git-alt
logo: fontawesome/solid/chart-line
language: en
direction: ltr
favicon: assets/logo.png
features:
- navigation.top
- navigation.tabs
- navigation.tracking
- navigation.expand
- search.suggest
- search.highlight
# Extensions
markdown_extensions:
- admonition
- meta
- attr_list
- md_in_html
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:pymdownx.emoji.twemoji
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.mark
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.betterem
- pymdownx.highlight
- pymdownx.superfences
# Plugins
plugins:
- search
- glightbox
- minify:
minify_html: true
- git-revision-date-localized:
type: date
# Navigation
nav:
- Home: index.md
- Getting Started:
- Introduction: getting-started/index.md
- Hosting with Docker: getting-started/docker-hosting.md
- Hosting with Node.js: getting-started/node-hosting.md
- Creating your First Application: getting-started/creating-your-first-application.md
- Uploading Data: getting-started/uploading-data.md
- Exporting Data: getting-started/exporting-data.md
- Reference:
- Introduction: reference/index.md
- Application: reference/application.md
- Schema: reference/schema.md
- Connector: reference/connector.md
- Data Entries: reference/data-entries.md
- API Reference: https://freenalytics.github.io/api-docs/
- Official Templates:
- Introduction: official-templates/index.md
- Official Web Template: official-templates/web-template.md
- Examples:
- Introduction: examples/index.md
- Webpage Example: examples/webpage-example.md
- Discord Bot Example: examples/discord-bot-example.md
- Data Treatment:
- Introduction: data-treatment/index.md
- Page Clicks View: data-treatment/page-clicks-view.md
- Development:
- Introduction: development/index.md
- Server: development/server.md
- Web Dashboard: development/web-dashboard.md
- Connector Development:
- Introduction: development/connectors/index.md
- Custom Connector: development/connectors/custom-connector.md
- freenalytics-connector-web: development/connectors/freenalytics-connector-web.md