forked from pinterest/ktlint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
79 lines (74 loc) · 2.17 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
site_name: Ktlint
site_url: https://pinterest.github.io/ktlint/
theme:
name: material
favicon: assets/images/favicon.ico
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
toggle:
icon: material/brightness-4
name: Switch to light mode
icon:
repo: material/github
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- search.suggest
- search.share
nav:
- Home: index.md
- Installation:
- Overview: install/overview.md
- Command line: install/cli.md
- Integrations: install/integrations.md
# - API: install/api.md TODO: properly document
- Snapshot build: install/snapshot-build.md
- Rules:
- Standard rules: rules/standard.md
- Experimental rules: rules/experimental.md
- Dependencies: rules/dependencies.md
- KtLint configuration: rules/configuration-ktlint.md
- IntelliJ IDEA configuration: rules/configuration-intellij-idea.md
- Extensions:
- Custom rule set: extensions/custom-rule-set.md
- Custom reporter: extensions/custom-reporter.md
- Badge: extensions/badge.md
- FAQ: faq.md
- Contributing:
- Overview: contributing/overview.md
- Guidelines: contributing/guidelines.md
- Code of conduct: contributing/code-of-conduct.md
plugins:
- search
repo_url: https://github.com/pinterest/ktlint
repo_name: pinterest/ktlint
markdown_extensions:
- toc:
permalink: true
- admonition
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true