pythonnative/mkdocs.yml at docs/cli-platform-help · glenlouis8/pythonnative · GitHub

History

232 lines (225 loc) · 6.61 KB

Raw

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

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

site_name: PythonNative

site_description: Cross-platform native UI toolkit for Android and iOS

site_author: Owen Carey

site_url: https://pythonnative.com/

repo_url: https://github.com/pythonnative/pythonnative

repo_name: pythonnative/pythonnative

edit_uri: edit/main/docs/

theme:

logo: assets/logo-256.jpg

favicon: assets/favicon.png

features:

- announce.dismiss

- content.action.edit

- content.action.view

- content.code.annotate

- content.code.copy

- content.tabs.link

- content.tooltips

- navigation.expand

- navigation.indexes

- navigation.instant

- navigation.instant.progress

- navigation.sections

- navigation.tabs

- navigation.tabs.sticky

- navigation.top

- navigation.tracking

- search.highlight

- search.suggest

- search.share

- toc.follow

palette:

- media: "(prefers-color-scheme: light)"

scheme: default

primary: white

toggle:

icon: material/weather-sunny

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: black

toggle:

icon: material/weather-night

font:

text: Inter

code: JetBrains Mono

icon:

repo: fontawesome/brands/github

edit: material/pencil

view: material/eye

extra:

generator: false

social:

- icon: fontawesome/brands/github

link: https://github.com/pythonnative/pythonnative

- icon: fontawesome/brands/python

link: https://pypi.org/project/pythonnative/

nav:

- Home: index.md

- Getting Started: getting-started.md

- Concepts:

- Mental Model: concepts/mental-model.md

- Architecture: concepts/architecture.md

- Components: concepts/components.md

- Hooks: concepts/hooks.md

- Lifecycle: concepts/lifecycle.md

- Reconciliation: concepts/reconciliation.md

- Layout Engine: concepts/layout.md

- Native Views: concepts/native-views.md

- The Native Bridge: concepts/bridge.md

- Guides:

- Android: guides/android.md

- iOS: guides/ios.md

- Development Workflow: guides/dev-workflow.md

- Browser Preview: guides/browser-preview.md

- Navigation: guides/navigation.md

- Styling: guides/styling.md

- Animations: guides/animations.md

- Gestures: guides/gestures.md

- Lists: guides/lists.md

- Async + Data: guides/async.md

- Platform & Accessibility: guides/platform-accessibility.md

- Native Modules: guides/native-modules.md

- PyPI Packages: guides/pypi-packages.md

- Custom Native Components: guides/custom-native-components.md

- Fast Refresh: guides/hot-reload.md

- Error Boundaries: guides/error-boundaries.md

- Testing: guides/testing.md

- Building:

- Configuration: guides/configuration.md

- Permissions: guides/permissions.md

- Building for Release: guides/building-for-release.md

- Examples:

- Overview: examples.md

- Hello World: examples/hello-world.md

- Counter: examples/counter.md

- Forms: examples/forms.md

- Lists: examples/lists.md

- Navigation: examples/navigation.md

- Collapsing Header & Bottom Sheet: examples/collapsing-header.md

- API Reference:

- Package: api/pythonnative.md

- Component: api/component.md

- Components: api/components.md

- Hooks: api/hooks.md

- Animated: api/animated.md

- Gestures: api/gestures.md

- Alerts: api/alerts.md

- Async runtime: api/runtime.md

- Suspense: api/suspense.md

- Appearance: api/appearance.md

- Images: api/images.md

- Network: api/net.md

- Storage: api/storage.md

- Platform: api/platform.md

- Element: api/element.md

- Hosts: api/hosts.md

- Reconciler: api/reconciler.md

- Layout: api/layout.md

- Style: api/style.md

- Navigation: api/navigation.md

- Testing: api/testing.md

- Native modules: api/native_modules.md

- Native views: api/native_views.md

- Bridge: api/bridge.md

- Mutation ops: api/mutations.md

- Events: api/events.md

- Platform metrics: api/platform_metrics.md

- SDK: api/sdk.md

- Dev server: api/devserver.md

- Hot reload: api/hot_reload.md

- Diagnostics: api/diagnostics.md

- Utilities: api/utils.md

- CLI (pn): api/cli.md

- Component properties: api/component-properties.md

- Meta:

- Style Guide: meta/style-guide.md

- Contributing: meta/contributing.md

- FAQ: meta/faq.md

- Troubleshooting: meta/troubleshooting.md

- Changelog: meta/changelog.md

plugins:

- search:

separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

- autorefs

- mkdocstrings:

default_handler: python

handlers:

python:

inventories:

- https://docs.python.org/3/objects.inv

options:

docstring_style: google

docstring_section_style: table

members_order: source

merge_init_into_class: true

separate_signature: true

show_bases: true

show_root_heading: true

show_root_full_path: false

show_signature_annotations: true

show_source: false

show_symbol_type_heading: true

show_symbol_type_toc: true

signature_crossrefs: true

summary: true

filters: ["!^_"]

- social:

cards_layout_options:

background_color: "#ffffff"

color: "#000000"

extra_css:

- styles/brand.css

markdown_extensions:

- abbr

- admonition

- attr_list

- codehilite

- def_list

- footnotes

- md_in_html

- tables

- toc:

permalink: true

toc_depth: 4

- pymdownx.betterem

- pymdownx.caret

- pymdownx.details

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.keys

- pymdownx.magiclink:

repo_url_shorthand: true

user: pythonnative

repo: pythonnative

- pymdownx.mark

- pymdownx.smartsymbols

- pymdownx.snippets:

base_path: ["."]

check_paths: true

- pymdownx.superfences:

custom_fences:

- name: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tabbed:

alternate_style: true

slugify: !!python/object/apply:pymdownx.slugs.slugify

kwds:

case: lower

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.tilde

watch:

- src/pythonnative

pythonnative/mkdocs.yml at docs/cli-platform-help · glenlouis8/pythonnative · GitHub

Expand file tree

Breadcrumbs

mkdocs.yml

Latest commit

History

Breadcrumbs

mkdocs.yml

File metadata and controls