mirror of https://github.com/vapor/docs.git
159 lines
5.3 KiB
YAML
159 lines
5.3 KiB
YAML
site_name: Vapor Docs
|
|
copyright: Copyright © 2018 Qutheory, LLC
|
|
site_url: https://docs.vapor.codes/3.0/
|
|
nav:
|
|
- 'Overview': 'index.md'
|
|
- 'Install':
|
|
- 'macOS': 'install/macos.md'
|
|
- 'Ubuntu': 'install/ubuntu.md'
|
|
- 'Getting Started':
|
|
- 'Hello, world': 'getting-started/hello-world.md'
|
|
- 'Toolbox': 'getting-started/toolbox.md'
|
|
- 'SPM': 'getting-started/spm.md'
|
|
- 'Xcode': 'getting-started/xcode.md'
|
|
- 'Folder Structure': 'getting-started/structure.md'
|
|
- 'Application': 'getting-started/application.md'
|
|
- 'Controllers': 'getting-started/controllers.md'
|
|
- 'Routing': 'getting-started/routing.md'
|
|
- 'Content': 'getting-started/content.md'
|
|
- 'Async': 'getting-started/async.md'
|
|
- 'Services': 'getting-started/services.md'
|
|
- 'Deployment': 'getting-started/cloud.md'
|
|
- 'Async':
|
|
- 'Getting Started': 'async/getting-started.md'
|
|
- 'Overview': 'async/overview.md'
|
|
- 'Auth':
|
|
- 'Getting Started': 'auth/getting-started.md'
|
|
- 'Stateless (API)': 'auth/api.md'
|
|
- 'Sessions (Web)': 'auth/web.md'
|
|
- 'Console':
|
|
- 'Getting Started': 'console/getting-started.md'
|
|
- 'Overview': 'console/overview.md'
|
|
- 'Command':
|
|
- 'Getting Started': 'command/getting-started.md'
|
|
- 'Overview': 'command/overview.md'
|
|
- 'Crypto':
|
|
- 'Getting Started': 'crypto/getting-started.md'
|
|
- 'Digests': 'crypto/digests.md'
|
|
- 'Ciphers': 'crypto/ciphers.md'
|
|
- 'Asymmetric': 'crypto/asymmetric.md'
|
|
- 'Random': 'crypto/random.md'
|
|
- 'TOTP & HOTP': 'crypto/otp.md'
|
|
- 'Database Kit':
|
|
- 'Getting Started': 'database-kit/getting-started.md'
|
|
- 'Overview': 'database-kit/overview.md'
|
|
- 'Fluent':
|
|
- 'Getting Started': 'fluent/getting-started.md'
|
|
- 'Models': 'fluent/models.md'
|
|
- 'Querying': 'fluent/querying.md'
|
|
- 'Migrations': 'fluent/migrations.md'
|
|
- 'Relations': 'fluent/relations.md'
|
|
- 'Transaction': 'fluent/transaction.md'
|
|
- 'HTTP':
|
|
- 'Getting Started': 'http/getting-started.md'
|
|
- 'Client': 'http/client.md'
|
|
- 'Server': 'http/server.md'
|
|
- 'Message': 'http/message.md'
|
|
- 'Jobs':
|
|
- 'Getting Started': 'jobs/getting-started.md'
|
|
- 'Redis Driver': 'jobs/redis-driver.md'
|
|
- 'Modeling Jobs': 'jobs/jobs.md'
|
|
- 'Dispatching Jobs': 'jobs/dispatching-jobs.md'
|
|
- 'Scheduling Jobs': 'jobs/scheduling-jobs.md'
|
|
- 'JWT':
|
|
- 'Getting Started': 'jwt/getting-started.md'
|
|
- 'Overview': 'jwt/overview.md'
|
|
- 'Leaf':
|
|
- 'Getting Started': 'leaf/getting-started.md'
|
|
- 'Overview': 'leaf/overview.md'
|
|
- 'Custom tags': 'leaf/custom-tags.md'
|
|
- 'Logging':
|
|
- 'Getting Started': 'logging/getting-started.md'
|
|
- 'Overview': 'logging/overview.md'
|
|
- 'Multipart':
|
|
- 'Getting Started': 'multipart/getting-started.md'
|
|
- 'Overview': 'multipart/overview.md'
|
|
- 'MySQL':
|
|
- 'Getting Started': 'mysql/getting-started.md'
|
|
- 'PostgreSQL':
|
|
- 'Getting Started': 'postgresql/getting-started.md'
|
|
- 'Redis':
|
|
- 'Getting Started': 'redis/getting-started.md'
|
|
- 'Overview': 'redis/overview.md'
|
|
- 'Routing':
|
|
- 'Getting Started': 'routing/getting-started.md'
|
|
- 'Overview': 'routing/overview.md'
|
|
- 'Service':
|
|
- 'Getting Started': 'service/getting-started.md'
|
|
- 'Services': 'service/services.md'
|
|
- 'Provider': 'service/provider.md'
|
|
- 'SQL':
|
|
- 'Getting Started': 'sql/getting-started.md'
|
|
- 'Overview': 'sql/overview.md'
|
|
- 'SQLite':
|
|
- 'Getting Started': 'sqlite/getting-started.md'
|
|
- 'Template Kit':
|
|
- 'Getting Started': 'template-kit/getting-started.md'
|
|
- 'Testing':
|
|
- 'Getting Started': 'testing/getting-started.md'
|
|
- 'URL-Encoded Form':
|
|
- 'Getting Started': 'url-encoded-form/getting-started.md'
|
|
- 'Overview': 'url-encoded-form/overview.md'
|
|
- 'Validation':
|
|
- 'Getting Started': 'validation/getting-started.md'
|
|
- 'Overview': 'validation/overview.md'
|
|
- 'Vapor':
|
|
- 'Getting Started': 'vapor/getting-started.md'
|
|
- 'Client': 'vapor/client.md'
|
|
- 'Content': 'vapor/content.md'
|
|
- 'Sessions': 'vapor/sessions.md'
|
|
- 'WebSocket': 'vapor/websocket.md'
|
|
- 'Middleware': 'vapor/middleware.md'
|
|
- 'WebSocket':
|
|
- 'Getting Started': 'websocket/getting-started.md'
|
|
- 'Overview': 'websocket/overview.md'
|
|
- 'Deploy':
|
|
- 'Heroku': 'deploy/heroku.md'
|
|
- 'Extras':
|
|
- 'Style Guide': 'extras/style-guide.md'
|
|
- 'Yeoman': 'extras/yeoman.md'
|
|
- 'Version (3.0)':
|
|
- '1.5': 'version/1_5.md'
|
|
- '2.0': 'version/2_0.md'
|
|
- '3.0': 'version/3_0.md'
|
|
- '4.0': 'version/4_0.md'
|
|
- 'Upgrading': 'version/upgrading.md'
|
|
- 'Support': 'version/support.md'
|
|
markdown_extensions:
|
|
- admonition
|
|
- codehilite:
|
|
guess_lang: false
|
|
- footnotes
|
|
- meta
|
|
- toc:
|
|
permalink: true
|
|
theme:
|
|
name: "material"
|
|
custom_dir: "theme/"
|
|
palette:
|
|
primary: "blue"
|
|
accent: "purple"
|
|
logo: 'images/droplet-white.svg'
|
|
repo_url: http://github.com/vapor/vapor
|
|
edit_uri: https://github.com/vapor/documentation/edit/master/3.0/docs/
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/twitter
|
|
link: 'https://twitter.com/@codevapor'
|
|
- icon: fontawesome/brands/discord
|
|
link: 'http://vapor.team/'
|
|
- icon: fontawesome/brands/github
|
|
link: 'https://github.com/vapor'
|
|
font:
|
|
text: 'Roboto Slab'
|
|
code: 'Source Code Pro'
|
|
disqus: 'vapor-docs'
|
|
google_analytics:
|
|
- 'UA-76177358-4'
|
|
- 'auto'
|