mirror of https://github.com/vapor/docs.git
423 lines
12 KiB
YAML
423 lines
12 KiB
YAML
# 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: "Copyright © Vapor Community"
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
custom_dir: theme/
|
|
language: en
|
|
locale: en
|
|
font: false
|
|
|
|
palette:
|
|
primary: black
|
|
accent: blue
|
|
|
|
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
|
|
|
|
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:
|
|
default_language: 'en'
|
|
search_reconfigure: false
|
|
material_alternate: true
|
|
# Add the new languages here. DON'T CHANGE THE DEFAULT LANGUAGE
|
|
languages:
|
|
en:
|
|
name: English
|
|
build: true
|
|
zh:
|
|
name: 简体中文
|
|
site_name: Vapor 中文文档
|
|
build: true
|
|
nl:
|
|
name: Nederlands
|
|
site_name: Vapor Documentatie
|
|
build: true
|
|
fr:
|
|
name: Français
|
|
site_name: Documentation Vapor
|
|
build: true
|
|
de:
|
|
name: German
|
|
site_name: Vapor Dokumentation
|
|
build: true
|
|
it:
|
|
name: Italiano
|
|
site_name: Documentazione di Vapor
|
|
build: true
|
|
es:
|
|
name: Español
|
|
site_name: Documentación de Vapor
|
|
build: true
|
|
# Add navigation translations here
|
|
nav_translations:
|
|
nl:
|
|
Welcome: Welkom
|
|
Install: Installeren
|
|
Getting Started: Aan De Slag
|
|
Hello, world: Hallo, wereld
|
|
Folder Structure: Folder Structuur
|
|
Basics: Basis
|
|
Routing: Routering
|
|
Content: Inhoud
|
|
Validation: Validatie
|
|
Async: Asynchroon
|
|
Logging: Loggen
|
|
Environment: Omgeving
|
|
Overview: Overzicht
|
|
Relations: Relaties
|
|
Migrations: Migraties
|
|
Query: Opvragen
|
|
Transactions: Transacties
|
|
Schema: Schema
|
|
Advanced: Geavanceerd
|
|
Testing: Testen
|
|
Files: Bestanden
|
|
Commands: Commando's
|
|
Queues: Wachtrijen
|
|
Sessions: Sessies
|
|
Services: Diensten
|
|
Security: Veiligheid
|
|
Authentication: Authenticatie
|
|
Crypto: Encryptie
|
|
Passwords: Wachtwoorden
|
|
Deploy: Opzetten
|
|
Version (4.0): Versie (4.0)
|
|
Legacy Docs: Oude Documentatie
|
|
Upgrading: Upgraden
|
|
Custom Tags: Zelfgemaakte Tags
|
|
Contributing: Bijdragen
|
|
Contributing Guide: Gids Bijdragen
|
|
fr:
|
|
Welcome: Bienvenue
|
|
Install: Installer
|
|
Getting Started: Commencer
|
|
Hello, world: Bonjour, monde
|
|
Basis: Bases
|
|
Folder Structure: Strucutre du Dossier
|
|
Content: Contenu
|
|
Validation: Validation
|
|
Async: Asynchrone
|
|
Environment: Environement
|
|
Overview: Aperçu
|
|
Relataions: Relations
|
|
Migrations: Migrations
|
|
Query: Requête
|
|
Transactions: Transactions
|
|
Schema: Schema
|
|
Advanced: Avancé
|
|
Testing: Test
|
|
Files: Fichiers
|
|
Commands: Commandes
|
|
Queues: Files d'attente
|
|
Sessions: Sessions
|
|
Services: Sercvies
|
|
Security: Securité
|
|
Authentication: Authentication
|
|
Passwords: Mots de passe
|
|
Deploy: Deployer
|
|
Version (4.0): Version (4.0)
|
|
Legacy Docs: Documents hérité
|
|
Upgrading: Mettre à jour
|
|
Custom Tags: Tags customisés
|
|
Contributing: Contribuer
|
|
Contributing Guide: Guide de la contribution
|
|
de:
|
|
Welcome: Begrüßung
|
|
Install: Installation
|
|
Getting Started: Einführung
|
|
Basics: Grundlagen
|
|
Hello, world: Hallo Welt
|
|
Folder Structure: Verzeichnis
|
|
Validation: Validierung
|
|
Logging: Protokollierung
|
|
Environment: Umgebung
|
|
Errors: Fehlerbehandlung
|
|
Model: Models
|
|
Overview: Übersicht
|
|
Relations: Beziehungen
|
|
Migrations: Migrationen
|
|
Query: Abfrage
|
|
Transactions: Transaktionen
|
|
Sessions: Sitzungen
|
|
Advanced: Erweitert
|
|
Testing: Testen
|
|
Files: Dateien
|
|
Commands: Befehle
|
|
Services: Dienste
|
|
Authentication: Authentifzierung
|
|
Security: Sicherheit
|
|
Deploy: Bereitstellung
|
|
Contributing: Mitwirken
|
|
Contributing Guide: Leitfaden für Beiträge
|
|
zh:
|
|
Welcome: 序言
|
|
Install: 安装
|
|
Getting Started: 开始
|
|
Hello, world: 你好世界
|
|
Folder Structure: 项目结构
|
|
SwiftPM: Swift 包管理器
|
|
Xcode: Xcode
|
|
Basics: 入门
|
|
Routing: 路由
|
|
Content: 内容
|
|
Client: 客户端
|
|
Validation: 验证
|
|
Async: 异步
|
|
Logging: 日志
|
|
Environment: 环境
|
|
Errors: 错误
|
|
Fluent: Fluent
|
|
Overview: 概述
|
|
Model: 模型
|
|
Relations: 关联
|
|
Migrations: 迁移
|
|
Query: 查询
|
|
Transactions: 事务
|
|
Schema: 模式
|
|
Leaf: Leaf
|
|
Custom Tags: 自定义标签
|
|
Redis: Redis
|
|
Advanced: 进阶
|
|
Middleware: 中间件
|
|
Testing: 测试
|
|
Server: 服务器
|
|
Files: 文件
|
|
Commands: 命令
|
|
Queues: 队列
|
|
WebSockets: 即时通讯
|
|
Sessions: 会话
|
|
Services: 服务
|
|
Security: 安全
|
|
APNS: 苹果推送服务
|
|
Deploy: 部署
|
|
Authentication: 认证
|
|
Crypto: 加密
|
|
Passwords: 密码
|
|
JWT: JWT
|
|
Contributing: 贡献
|
|
Contributing Guide: 贡献指南
|
|
Version (4.0): 版本 (4.0)
|
|
it:
|
|
Welcome: Benvenuto
|
|
Install: Installazione
|
|
Getting Started: Inizio
|
|
Hello, world: Ciao, mondo
|
|
Folder Structure: Struttura della Cartella
|
|
SwiftPM: SwiftPM
|
|
Xcode: Xcode
|
|
Basics: Basi
|
|
Routing: Routing
|
|
Content: Contenuto
|
|
Client: Client
|
|
Validation: Validazione
|
|
Async: Asincrono
|
|
Logging: Logging
|
|
Environment: Ambiente
|
|
Errors: Errori
|
|
Fluent: Fluent
|
|
Overview: Panoramica
|
|
Model: Modello
|
|
Relations: Relazioni
|
|
Migrations: Migrazioni
|
|
Query: Query
|
|
Transactions: Transazioni
|
|
Schema: Schema
|
|
Leaf: Leaf
|
|
Custom Tags: Tag Personalizzati
|
|
Redis: Redis
|
|
Advanced: Avanzate
|
|
Middleware: Middleware
|
|
Testing: Test
|
|
Server: Server
|
|
Files: File
|
|
Commands: Comandi
|
|
Queues: Code
|
|
WebSockets: WebSockets
|
|
Sessions: Sessioni
|
|
Services: Servizi
|
|
Security: Sicurezza
|
|
APNS: APNS
|
|
Deploy: Deploy
|
|
Authentication: Autenticazione
|
|
Crypto: Crittografia
|
|
Passwords: Password
|
|
JWT: JWT
|
|
Contributing: Contribuire
|
|
Contributing Guide: Guida alla Contribuzione
|
|
Version (4.0): Versione (4.0)
|
|
Legacy Docs: Documentazione Legacy
|
|
Upgrading: Aggiornamento
|
|
es:
|
|
Welcome: Bienvenido
|
|
Install: Instalación
|
|
Getting Started: Comenzando
|
|
Hello, world: Hola, mundo
|
|
Folder Structure: Estructura de carpetas
|
|
SwiftPM: SwiftPM
|
|
Xcode: Xcode
|
|
Basics: Fundamentos
|
|
Routing: Routing
|
|
Content: Content
|
|
Client: Client
|
|
Validation: Validación
|
|
Async: Async
|
|
Logging: Logging
|
|
Environment: Ambiente
|
|
Errors: Errores
|
|
Fluent: Fluent
|
|
Overview: Presentación
|
|
Model: Modelo
|
|
Relations: Relaciones
|
|
Migrations: Migraciones
|
|
Query: Consultas
|
|
Transactions: Transacciones
|
|
Schema: Esquema
|
|
Leaf: Leaf
|
|
Custom Tags: Etiquetas Personalizadas
|
|
Redis: Redis
|
|
Advanced: Avanzado
|
|
Middleware: Middleware
|
|
Testing: Testing
|
|
Server: Servidor
|
|
Files: Ficheros
|
|
Commands: Comandos
|
|
Queues: Colas
|
|
WebSockets: WebSockets
|
|
Sessions: Sesiones
|
|
Services: Servicios
|
|
Security: Seguridad
|
|
APNS: APNS
|
|
Deploy: Desplegar
|
|
Authentication: Autenticación
|
|
Crypto: Criptografía
|
|
Passwords: Contraseñas
|
|
JWT: JWT
|
|
Contributing: Colaborar
|
|
Contributing Guide: Guía pra colaborar
|
|
Version (4.0): Versión (4.0)
|
|
Legacy Docs: Documentación Legacy
|
|
Upgrading: Actualizar
|
|
|
|
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: "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"
|
|
- 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"
|