From 8a9f617a158cdcc890977709b32ddbcc3fb9250e Mon Sep 17 00:00:00 2001 From: tanner0101 Date: Sat, 13 Jun 2020 13:01:45 -0400 Subject: [PATCH] fix mkdocs.yml formatting --- 2.0/mkdocs.yml | 6 ++- 3.0/docs/logo.svg | 18 ++++++++ 3.0/mkdocs.yml | 28 +++++------- 4.0/mkdocs.yml | 112 +++++++++++++++++++++++----------------------- 4 files changed, 89 insertions(+), 75 deletions(-) create mode 100644 3.0/docs/logo.svg diff --git a/2.0/mkdocs.yml b/2.0/mkdocs.yml index 551abf85..beb38a65 100644 --- a/2.0/mkdocs.yml +++ b/2.0/mkdocs.yml @@ -124,10 +124,12 @@ edit_uri: https://github.com/vapor/documentation/edit/master/2.0/docs/ extra: logo: 'images/droplet-white.svg' social: - - type: 'twitter' + - icon: fontawesome/brands/twitter link: 'https://twitter.com/@codevapor' - - type: 'slack' + - 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' diff --git a/3.0/docs/logo.svg b/3.0/docs/logo.svg new file mode 100644 index 00000000..9f645196 --- /dev/null +++ b/3.0/docs/logo.svg @@ -0,0 +1,18 @@ + + + Vapor + The Vapor droplet logo in white. + + + + \ No newline at end of file diff --git a/3.0/mkdocs.yml b/3.0/mkdocs.yml index 54803bed..f3bc0edc 100644 --- a/3.0/mkdocs.yml +++ b/3.0/mkdocs.yml @@ -1,7 +1,6 @@ -site_name: 'Vapor Docs' -copyright: 'Copyright © 2018 Qutheory, LLC' -site_url: 'https://docs.vapor.codes/3.0/' - +site_name: Vapor Docs +copyright: Copyright © 2018 Qutheory, LLC +site_url: https://docs.vapor.codes/3.0/ nav: - 'Overview': 'index.md' - 'Install': @@ -125,8 +124,6 @@ nav: - '4.0': 'version/4_0.md' - 'Upgrading': 'version/upgrading.md' - 'Support': 'version/support.md' - - markdown_extensions: - admonition - codehilite: @@ -135,30 +132,27 @@ markdown_extensions: - meta - toc: permalink: true - theme: - name: 'material' - custom_dir: 'theme/' + name: "material" + custom_dir: "theme/" palette: - primary: 'blue' - accent: 'purple' - # logo: 'images/droplet-white.svg' - + primary: "blue" + accent: "purple" + logo: "logo.svg" repo_url: http://github.com/vapor/vapor edit_uri: https://github.com/vapor/documentation/edit/master/3.0/docs/ extra: social: - - type: 'twitter' + - icon: fontawesome/brands/twitter link: 'https://twitter.com/@codevapor' - - type: 'slack' + - icon: fontawesome/brands/discord link: 'http://vapor.team/' - - type: 'github' + - 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' diff --git a/4.0/mkdocs.yml b/4.0/mkdocs.yml index cbb8c7a1..265aa322 100644 --- a/4.0/mkdocs.yml +++ b/4.0/mkdocs.yml @@ -1,18 +1,18 @@ site_name: Vapor Docs -site_url: "https://docs.vapor.codes/4.0/" +site_url: https://docs.vapor.codes/4.0/ repo_url: http://github.com/vapor/vapor edit_uri: https://github.com/vapor/documentation/edit/master/4.0/docs/ theme: - name: 'material' - custom_dir: 'theme/' + name: "material" + custom_dir: "theme/" palette: primary: "black" accent: "blue" logo: "logo.png" extra: font: - text: 'Roboto Slab' - code: 'Source Code Pro' + text: "Roboto Slab" + code: "Source Code Pro" google_analytics: - "UA-76177358-4" - "auto" @@ -25,56 +25,56 @@ markdown_extensions: - toc: permalink: true nav: -- 'Welcome': 'index.md' -- 'Install': - - 'macOS': 'install/macos.md' - - 'Linux': 'install/linux.md' -- 'Getting Started': - - 'Hello, world': 'hello-world.md' - - 'Folder Structure': 'folder-structure.md' - - 'SPM': 'spm.md' -- 'Basics': - - 'Routing': 'routing.md' +- "Welcome": "index.md" +- "Install": + - "macOS": "install/macos.md" + - "Linux": "install/linux.md" +- "Getting Started": + - "Hello, world": "hello-world.md" + - "Folder Structure": "folder-structure.md" + - "SPM": "spm.md" +- "Basics": + - "Routing": "routing.md" # TODO: Improve quality # Mostly just a code sample with little explanation. -# - 'Controllers': 'controllers.md' - - 'Content': 'content.md' - - 'Client': 'client.md' - - 'Validation': 'validation.md' - - 'Async': 'async.md' - - 'Logging': 'logging.md' - - 'Environment': 'environment.md' - - 'Errors': 'errors.md' -- 'Fluent': - - 'Overview': 'fluent/overview.md' - - 'Model': 'fluent/model.md' - - 'Relations': 'fluent/relations.md' - - 'Migration': 'fluent/migration.md' - - 'Query': 'fluent/query.md' - - 'Schema': 'fluent/schema.md' - - 'Advanced': 'fluent/advanced.md' -- 'Advanced': - - 'Middleware': 'middleware.md' - - 'Testing': 'testing.md' - - 'Server': 'server.md' - - 'Commands': 'commands.md' - - 'Queues': 'queues.md' - - 'WebSockets': 'websockets.md' - - 'Sessions': 'sessions.md' - - 'Services': 'services.md' -- 'Security': - - 'Authentication': 'authentication.md' - - 'Crypto': 'crypto.md' - - 'Passwords': 'passwords.md' -- 'Deploy': - - 'DigitalOcean': 'deploy/digital-ocean.md' - - 'Herouku': 'deploy/heroku.md' - - 'Supervisor': 'deploy/supervisor.md' - - 'Nginx': 'deploy/nginx.md' - - 'Docker': 'deploy/docker.md' -- 'Version (4.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': 'upgrading.md' +# - "Controllers": "controllers.md" + - "Content": "content.md" + - "Client": "client.md" + - "Validation": "validation.md" + - "Async": "async.md" + - "Logging": "logging.md" + - "Environment": "environment.md" + - "Errors": "errors.md" +- "Fluent": + - "Overview": "fluent/overview.md" + - "Model": "fluent/model.md" + - "Relations": "fluent/relations.md" + - "Migration": "fluent/migration.md" + - "Query": "fluent/query.md" + - "Schema": "fluent/schema.md" + - "Advanced": "fluent/advanced.md" +- "Advanced": + - "Middleware": "middleware.md" + - "Testing": "testing.md" + - "Server": "server.md" + - "Commands": "commands.md" + - "Queues": "queues.md" + - "WebSockets": "websockets.md" + - "Sessions": "sessions.md" + - "Services": "services.md" +- "Security": + - "Authentication": "authentication.md" + - "Crypto": "crypto.md" + - "Passwords": "passwords.md" +- "Deploy": + - "DigitalOcean": "deploy/digital-ocean.md" + - "Herouku": "deploy/heroku.md" + - "Supervisor": "deploy/supervisor.md" + - "Nginx": "deploy/nginx.md" + - "Docker": "deploy/docker.md" +- "Version (4.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": "upgrading.md"