forked from vapor/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
597 lines (585 loc) · 18.1 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
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
# Project information
site_name: Vapor Docs
site_url: https://docs.vapor.codes/
site_author: Vapor Community
site_description: Vapors documentation (web framework for Swift).
# Repository
repo_name: Vapor GitHub
repo_url: http://github.com/vapor/vapor
edit_uri: https://github.com/vapor/documentation/edit/main/docs/
# Copyright
copyright: "Vapor Documentation © 2023 by Vapor is licensed under CC BY-NC-SA 4.0"
# Configuration
theme:
name: material
custom_dir: theme/
language: en
locale: en
font: false
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: black
accent: blue
scheme: default
toggle:
icon: material/brightness-4
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: black
accent: blue
scheme: slate
toggle:
icon: material/brightness-7
name: Switch to light mode
logo: assets/logo.png
favicon: assets/favicon.png
features:
- search.suggest
- search.highlight
# Customization
extra:
# Font
font:
text: Roboto Slab
code: Source Code Pro
# Social
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/codevapor
- icon: fontawesome/brands/discord
link: https://discord.gg/vapor
- icon: fontawesome/brands/github
link: https://github.com/vapor
- icon: fontawesome/brands/mastodon
link: https://hachyderm.io/@codevapor
extra_css:
- stylesheets/syntax.css
- stylesheets/fonts.css
extra_javascript:
- javascripts/highlight.min.js
- javascripts/startSyntaxHighlighting.js
# Extensions
markdown_extensions:
- admonition
- footnotes
- meta
- toc:
permalink: true
# Plugins
plugins:
- search:
lang: en
# i18n plugin documentation
# https://github.com/ultrabug/mkdocs-static-i18n
- i18n:
docs_structure: suffix
fallback_to_default: true
languages:
- build: true
default: true
locale: en
name: English
- build: true
default: false
locale: zh
name: 简体中文
nav_translations:
APNS: 苹果推送服务
Advanced: 进阶
Async: 异步
Authentication: 认证
Basics: 入门
Client: 客户端
Commands: 命令
Content: 内容
Contributing: 贡献
Contributing Guide: 贡献指南
Crypto: 加密
Custom Tags: 自定义标签
Deploy: 部署
Environment: 环境
Errors: 错误
Files: 文件
Fluent: Fluent
Folder Structure: 项目结构
Getting Started: 开始
Hello, world: 你好世界
Install: 安装
JWT: JWT
Leaf: Leaf
Logging: 日志
Middleware: 中间件
Migrations: 迁移
Model: 模型
Overview: 概述
Passwords: 密码
Query: 查询
Queues: 队列
Redis: Redis
Relations: 关联
Routing: 路由
Schema: 模式
Security: 安全
Server: 服务器
Services: 服务
Sessions: 会话
SwiftPM: Swift 包管理器
Testing: 测试
Transactions: 事务
Validation: 验证
Version (4.0): 版本 (4.0)
WebSockets: 即时通讯
Welcome: 序言
Xcode: Xcode
site_name: Vapor 中文文档
- build: true
default: false
locale: nl
name: Nederlands
nav_translations:
Advanced: Geavanceerd
Async: Asynchroon
Authentication: Authenticatie
Basics: Basis
Commands: Commando's
Content: Inhoud
Contributing: Bijdragen
Contributing Guide: Gids Bijdragen
Crypto: Encryptie
Custom Tags: Zelfgemaakte Tags
Deploy: Opzetten
Environment: Omgeving
Files: Bestanden
Folder Structure: Folder Structuur
Getting Started: Aan De Slag
Hello, world: Hallo, wereld
Install: Installeren
Legacy Docs: Oude Documentatie
Logging: Loggen
Migrations: Migraties
Overview: Overzicht
Passwords: Wachtwoorden
Query: Opvragen
Queues: Wachtrijen
Relations: Relaties
Routing: Routering
Schema: Schema
Security: Veiligheid
Services: Diensten
Sessions: Sessies
Testing: Testen
Transactions: Transacties
Upgrading: Upgraden
Validation: Validatie
Version (4.0): Versie (4.0)
Welcome: Welkom
site_name: Vapor Documentatie
- build: true
default: false
locale: fr
name: Français
nav_translations:
Advanced: Avancé
Async: Asynchrone
Authentication: Authentification
Basics: Bases
Commands: Commandes
Content: Contenu
Contributing: Contribuer
Contributing Guide: Guide de contribution
Controllers: Contrôleurs
Custom Tags: Tags customisés
Errors: Erreurs
Deploy: Deployer
Environment: Environement
Files: Fichiers
Folder Structure: Structure du Dossier
Getting Started: Commencer
Hello, world: Bonjour, monde
Install: Installer
Legacy Docs: Documents hérité
Migrations: Migrations
Overview: Aperçu
Passwords: Mots de passe
Query: Requête
Queues: Files d'attente
Relataions: Relations
Release Notes: Notes de Version
Request: Requête
Routing: Routage
Schema: Schema
Security: Securité
Services: Services
Sessions: Sessions
Testing: Test
Transactions: Transactions
Upgrading: Mettre à jour
Validation: Validation
Version (4.0): Version (4.0)
Welcome: Bienvenue
site_name: Documentation Vapor
- build: true
default: false
locale: de
name: German
nav_translations:
Advanced: Erweitert
Authentication: Authentifzierung
Basics: Grundlagen
Commands: Befehle
Content: Modelbindung
Contributing: Mitwirken
Contributing Guide: Leitfaden für Beiträge
Deploy: Bereitstellung
Environment: Umgebung
Errors: Fehlerbehandlung
Files: Dateien
Folder Structure: Verzeichnis
Getting Started: Einführung
Hello, world: Hallo Welt
Install: Installation
Logging: Protokollierung
Migrations: Migrationen
Model: Models
Overview: Übersicht
Query: Abfrage
Relations: Beziehungen
Security: Sicherheit
Services: Dienste
Sessions: Sitzungen
Testing: Testen
Transactions: Transaktionen
Validation: Validierung
Welcome: Begrüßung
site_name: Vapor Dokumentation
- build: true
default: false
locale: it
name: Italiano
nav_translations:
APNS: APNS
Advanced: Avanzate
Async: Asincrono
Authentication: Autenticazione
Basics: Basi
Client: Client
Commands: Comandi
Content: Contenuto
Contributing: Contribuire
Contributing Guide: Guida alla Contribuzione
Controllers: Controller
Crypto: Crittografia
Custom Tags: Tag Personalizzati
Deploy: Deploy
Environment: Ambiente
Errors: Errori
Files: File
Fluent: Fluent
Folder Structure: Struttura della Cartella
Getting Started: Inizio
Hello, world: Ciao, mondo
Install: Installazione
JWT: JWT
Leaf: Leaf
Legacy Docs: Documentazione Obsoleta
Logging: Logging
Middleware: Middleware
Migrations: Migrazioni
Model: Modello
Overview: Panoramica
Passwords: Password
Query: Query
Queues: Code
Redis: Redis
Relations: Relazioni
Release Notes: Note sulla Versione
Routing: Routing
Schema: Schema
Security: Sicurezza
Server: Server
Services: Servizi
Sessions: Sessioni
SwiftPM: SwiftPM
Testing: Test
Transactions: Transazioni
Upgrading: Aggiornamento
Validation: Validazione
Version (4.0): Versione (4.0)
WebSockets: WebSockets
Welcome: Benvenuto
Xcode: Xcode
site_name: Documentazione di Vapor
- build: true
default: false
locale: es
name: Español
nav_translations:
APNS: APNS
Advanced: Avanzado
Async: Asincronía
Authentication: Autenticación
Basics: Fundamentos
Client: Cliente
Commands: Comandos
Content: Content
Contributing: Colaborar
Contributing Guide: Guía para Colaborar
Controllers: Controladores
Crypto: Criptografía
Custom Tags: Etiquetas Personalizadas
Deploy: Desplegar
Environment: Entorno
Errors: Errores
Files: Ficheros
Fluent: Fluent
Folder Structure: Estructura de Carpetas
Getting Started: Comenzando
Hello, world: Hola, mundo
Install: Instalación
JWT: JWT
Leaf: Leaf
Legacy Docs: Documentación Legacy
Logging: Logging
Middleware: Middleware
Migrations: Migraciones
Model: Modelo
Overview: Presentación
Passwords: Contraseñas
Query: Consultas
Queues: Colas
Redis: Redis
Relations: Relaciones
Routing: Routing
Schema: Esquema
Security: Seguridad
Server: Servidor
Services: Servicios
Sessions: Sesiones
SwiftPM: SwiftPM
Testing: Testing
Transactions: Transacciones
Upgrading: Actualizar
Validation: Validación
Version (4.0): Versión (4.0)
WebSockets: WebSockets
Welcome: Bienvenido
Xcode: Xcode
site_name: Documentación de Vapor
- build: true
default: false
locale: pl
name: Polski
nav_translations:
APNS: APNS
Advanced: Zaawansowane
Async: Asynchroniczność
Authentication: Autentykacja
Basics: Podstawy
Client: Klient
Commands: Komendy
Content: Kontent
Contributing: Kontrybucja
Contributing Guide: Przewodnik do kontrybucji
Crypto: Kryptografia
Custom Tags: Własne tagi
Deploy: Wdrożenie
Environment: Środowisko
Errors: Błędy
Files: Pliki
Fluent: Fluent
Folder Structure: Struktura folderów
Getting Started: Jak zacząć
Hello, world: Witaj, świecie
Install: Instalacja
JWT: JWT
Leaf: Leaf
Legacy Docs: Przestażała dokumentacja
Logging: Logowanie
Middleware: Middleware
Migrations: Migracje
Model: Model
Overview: Prezentacja
Passwords: Hasła
Query: Zapytania
Queues: Kolejki
Redis: Redis
Relations: Relacje
Release Notes: Informacja o wersji
Routing: Kierowanie ruchem
Schema: Schematy
Security: Bezpieczeństwo
Server: Serwer
Services: Serwisy
Sessions: Sesje
SwiftPM: SwiftPM
Testing: Testowanie
Transactions: Transakcje
Upgrading: Aktualizacja
Validation: Walidacja
Version (4.0): Wersja (4.0)
WebSockets: WebSockety
Welcome: Witaj
Xcode: Xcode
site_name: Dokumentacja Vapor
- build: true
default: false
locale: ko
name: 한국어
nav_translations:
Advanced: 고급
Async: 비동기 처리
Authentication: 인증
Basics: 기본 사항
Client: 클라이언트
Commands: 명령어
Content: 컨텐츠
Contributing: 기여하기
Contributing Guide: 기여 가이드
Crypto: 암호화
Custom Tags: 사용자 정의 태그
Deploy: 배포
Environment: 환경 설정
Errors: 에러
Files: 파일
Folder Structure: 폴더 구조
Getting Started: 시작하기
Install: 설치
Legacy Docs: 이전 문서
Logging: 로깅
Migrations: 마이그레이션
Model: 모델
Overview: 개요
Passwords: 비밀번호
Query: 쿼리
Queues: 대기열
Relations: 관계
Routing: 라우팅
Schema: 스키마
Security: 보안
Services: 서비스
Sessions: 세션
Testing: 테스트
Transactions: 트랜잭션
Upgrading: 업그레이드
Validation: 유효성 검사
Version (4.0): 버전 (4.0)
WebSockets: 웹소켓
Welcome: 환영합니다
site_name: Vapor 문서
- build: true
default: false
locale: ja
name: 日本語
nav_translations:
Advanced: 上級
Async: 非同期
Authentication: 認証
Basics: 基礎
Client: クライアント
Commands: コマンド
Content: 内容
Contributing: 貢献
Contributing Guide: 貢献ガイド
Crypto: 暗号
Custom Tags: カスタムタグ
Deploy: デプロイ
Environment: 環境
Errors: エラー
Files: ファイル
Folder Structure: フォルダ構造
Getting Started: はじめに
Install: インストール
Legacy Docs: レガシードキュメント
Logging: ロギング
Migrations: マイグレーション
Model: モデル
Overview: 概要
Passwords: パスワード
Query: クエリ
Queues: 列
Relations: 関係
Release Notes: リリースノート
Routing: ルーティング
Schema: スキーマ
Security: セキュリティ
Services: サービス
Sessions: セッション
Testing: テスト
Transactions: トランザクション
Upgrading: アップグレード
Validation: バリデーション
Welcome: ようこそ
site_name: Vapor ドキュメント
reconfigure_material: true
reconfigure_search: false
nav:
- Welcome: "index.md"
- Install:
- macOS: "install/macos.md"
- Linux: "install/linux.md"
- Getting Started:
- Hello, world: "getting-started/hello-world.md"
- Folder Structure: "getting-started/folder-structure.md"
- SwiftPM: "getting-started/spm.md"
- Xcode: "getting-started/xcode.md"
- Basics:
- Routing: "basics/routing.md"
# TODO: Improve quality
# Mostly just a code sample with little explanation.
- Controllers: "basics/controllers.md"
- Content: "basics/content.md"
- Client: "basics/client.md"
- Validation: "basics/validation.md"
- Async: "basics/async.md"
- Logging: "basics/logging.md"
- Environment: "basics/environment.md"
- Errors: "basics/errors.md"
- Fluent:
- Overview: "fluent/overview.md"
- Model: "fluent/model.md"
- Relations: "fluent/relations.md"
- Migrations: "fluent/migration.md"
- Query: "fluent/query.md"
- Transactions: "fluent/transaction.md"
- Schema: "fluent/schema.md"
- Advanced: "fluent/advanced.md"
- Leaf:
- Getting Started: "leaf/getting-started.md"
- Overview: "leaf/overview.md"
- Custom Tags: "leaf/custom-tags.md"
- Redis:
- Overview: "redis/overview.md"
- Sessions: "redis/sessions.md"
- Advanced:
- Middleware: "advanced/middleware.md"
- Testing: "advanced/testing.md"
- Server: "advanced/server.md"
- Files: "advanced/files.md"
- Commands: "advanced/commands.md"
- Queues: "advanced/queues.md"
- WebSockets: "advanced/websockets.md"
- Sessions: "advanced/sessions.md"
- Services: "advanced/services.md"
- Request: "advanced/request.md"
- APNS: "advanced/apns.md"
- Security:
- Authentication: "security/authentication.md"
- Crypto: "security/crypto.md"
- Passwords: "security/passwords.md"
- JWT: "security/jwt.md"
- Deploy:
- DigitalOcean: "deploy/digital-ocean.md"
- Fly: "deploy/fly.md"
- Heroku: "deploy/heroku.md"
- Supervisor: "deploy/supervisor.md"
- Systemd: "deploy/systemd.md"
- Nginx: "deploy/nginx.md"
- Docker: "deploy/docker.md"
- Contributing:
- Contributing Guide: "contributing/contributing.md"
- Version (4.0):
- Legacy Docs: "version/legacy-docs.md"
- Upgrading: "upgrading.md"
- Release Notes: "release-notes.md"