xref: /aosp_15_r20/external/kotlinpoet/mkdocs.yml (revision 3c321d951dd070fb96f8ba59e952ffc3131379a0)
1# pip install mkdocs mkdocs-material
2# mkdocs serve
3# mkdocs gh-deploy
4
5site_name: KotlinPoet
6repo_name: KotlinPoet
7repo_url: https://github.com/square/kotlinpoet
8site_description: "A Kotlin API for generating .kt source files"
9site_author: Square, Inc.
10remote_branch: gh-pages
11
12copyright: 'Copyright © 2015 Square, Inc.'
13
14theme:
15  name: 'material'
16  logo: 'images/icon-square.png'
17  favicon: 'images/icon-square.png'
18  palette:
19    - media: '(prefers-color-scheme: light)'
20      scheme: default
21      primary: 'cyan'
22      accent: 'deep-purple'
23      toggle:
24        icon: material/weather-night
25        name: Switch to dark mode
26    - media: '(prefers-color-scheme: dark)'
27      scheme: slate
28      primary: 'black'
29      accent: 'blue-grey'
30      toggle:
31        icon: material/weather-sunny
32        name: Switch to light mode
33
34extra_css:
35  - 'css/app.css'
36
37markdown_extensions:
38  - smarty
39  - codehilite:
40      guess_lang: false
41  - footnotes
42  - meta
43  - toc:
44      permalink: true
45  - pymdownx.betterem:
46      smart_enable: all
47  - pymdownx.caret
48  - pymdownx.inlinehilite
49  - pymdownx.magiclink
50  - pymdownx.smartsymbols
51  - pymdownx.superfences
52  - pymdownx.emoji
53  - tables
54  - admonition
55
56nav:
57  - 'Overview':
58    - 'Code & Control Flow': code-control-flow.md
59    - 'Format Specifiers':
60      - '%S for Strings': s-for-strings.md
61      - '%P for String Templates': p-for-string-templates.md
62      - '%T for Types': t-for-types.md
63      - '%M for Members': m-for-members.md
64      - '%N for Names': n-for-names.md
65      - '%L for Literals': l-for-literals.md
66      - 'Code Block Format Strings': code-block-format-strings.md
67    - 'Functions': functions.md
68    - 'Constructors': constructors.md
69    - 'Parameters': parameters.md
70    - 'Properties': properties.md
71    - 'Interfaces': interfaces.md
72    - 'Objects': objects.md
73    - 'Enums': enums.md
74    - 'Anonymous Inner Classes': anonymous-inner-classes.md
75    - 'Annotations': annotations.md
76    - 'Type Aliases': type-aliases.md
77    - 'Callable References': callable-references.md
78    - 'kotlin-reflect': kotlin-reflect.md
79  - 'Interop - JavaPoet': interop-javapoet.md
80  - 'Interop - kotlin-metadata': interop-kotlin-metadata.md
81  - 'Interop - KSP': interop-ksp.md
82  - 'API':
83    - 'kotlinpoet': 1.x/kotlinpoet/index.html
84    - 'interop-javapoet': 1.x/interop-javapoet/index.html
85    - 'interop-kotlinx-metadata': 1.x/interop-kotlinx-metadata/index.html
86    - 'interop-ksp': 1.x/interop-ksp/index.html
87  - 'Stack Overflow ⏏': https://stackoverflow.com/questions/tagged/kotlinpoet?sort=active
88  - 'Change Log': changelog.md
89  - 'Contributing': contributing.md
90