fork/static-web-server
git clone https://git.julia.blue/fork/static-web-server
7ff6cf6
allow-symlink
1# Project information 2site_name : Static Web Server 3site_description : 'A cross-platform, high-performance and asynchronous web server for static files-serving ⚡' 4site_author : 'Jose Quintana' 5site_url : https://static-web-server.net 6 7# Repository 8repo_name : static-web-server/static-web-server 9repo_url : https://github.com/static-web-server/static-web-server/ 10edit_uri : edit/master/docs/content/ 11 12strict : true 13docs_dir : 'docs/content' 14site_dir : '/tmp/docs' 15extra_css : 16- 'assets/style.css' 17 18# Copyright 19copyright : Copyright © 2019-2024 Jose Quintana 20 21# Theme 22theme : 23name : 'material' 24logo : assets/sws_white.svg 25language : en 26include_sidebar : true 27features : 28- content.code.annotate 29- content.action.edit 30- content.action.view 31- content.tabs.link 32# - navigation.expand 33- navigation.indexes 34# - navigation.instant 35# - navigation.sections 36# - navigation.tabs 37- navigation.tabs.sticky 38- navigation.top 39- navigation.tracking 40- search.highlight 41- search.share 42- search.suggest 43- content.code.copy 44# - toc.integrate 45palette : 46- scheme : default 47primary : black 48accent : blue 49toggle : 50icon : material/toggle-switch-off-outline 51name : Switch to dark mode 52- scheme : slate 53primary : black 54accent : blue 55toggle : 56icon : material/toggle-switch 57name : Switch to light mode 58font : 59text : 'Open Sans' 60code : 'Droid Sans Mono' 61favicon : https://static-web-server.net/assets/sws.svg 62 63extra : 64social : 65- icon : 'fontawesome/brands/github' 66link : 'https://github.com/joseluisq' 67- icon : 'fontawesome/brands/twitter' 68link : 'https://twitter.com/joseluis_q' 69 70markdown_extensions : 71- admonition 72- abbr 73- def_list 74- md_in_html 75- codehilite 76- admonition 77- meta 78- attr_list 79- footnotes 80- tables 81- toc : 82permalink : true 83- markdown.extensions.tables 84- pymdownx.arithmatex 85- pymdownx.betterem 86- pymdownx.critic 87- pymdownx.caret 88- pymdownx.keys 89- pymdownx.mark 90- pymdownx.tilde 91- pymdownx.details 92- pymdownx.emoji : 93emoji_index : !!python/name:material.extensions.emoji.twemoji 94emoji_generator : !!python/name:material.extensions.emoji.to_svg 95- pymdownx.magiclink : 96repo_url_shortener : true 97repo_url_shorthand : true 98provider : "github" 99user : "facelessuser" 100repo : "pymdown-extensions" 101- pymdownx.superfences 102- pymdownx.inlinehilite 103- pymdownx.smartsymbols 104- pymdownx.tasklist 105- pymdownx.highlight : 106linenums : true 107linenums_style : pymdownx-inline 108- pymdownx.tabbed : 109alternate_style : true 110 111# Plugins 112plugins : 113- search 114- minify : 115minify_html : true 116- git-revision-date-localized : 117type : timeago 118custom_format : "%d. %B %Y" 119timezone : Europe/Berlin 120locale : en 121fallback_to_build_date : false 122enable_creation_date : false 123exclude : 124- index.md 125enabled : true 126strict : true 127 128# Content Navigation 129nav : 130- 'Overview' : 'index.md' 131- 'Getting Started' : 'getting-started.md' 132- 'Download and Install' : 'download-and-install.md' 133- 'Configuration' : 134- 'Command Line Arguments' : 'configuration/command-line-arguments.md' 135- 'Environment Variables' : 'configuration/environment-variables.md' 136- 'TOML Configuration File' : 'configuration/config-file.md' 137- 'Building from Source' : 'building-from-source.md' 138- 'Features' : 139- 'HTTP/1' : 'features/http1.md' 140- 'HTTP Methods' : 'features/http-methods.md' 141- 'HTTP/2 and TLS' : 'features/http2-tls.md' 142- 'HTTP to HTTPS redirect' : 'features/http-https-redirect.md' 143- 'Logging' : 'features/logging.md' 144- 'Compression' : 'features/compression.md' 145- 'Pre-compressed files serving' : 'features/compression-static.md' 146- 'Cache Control Headers' : 'features/cache-control-headers.md' 147- 'CORS' : 'features/cors.md' 148- 'Security Headers' : 'features/security-headers.md' 149- 'Basic Authentication' : 'features/basic-authentication.md' 150- 'Directory Listing' : 'features/directory-listing.md' 151- 'Docker' : 'features/docker.md' 152- 'Graceful Shutdown' : 'features/graceful-shutdown.md' 153- 'File Descriptor Socket Passing' : './features/file-descriptor-socket-passing.md' 154- 'Worker Threads Customization' : 'features/worker-threads.md' 155- 'Blocking Threads Customization' : 'features/blocking-threads.md' 156- 'Error Pages' : 'features/error-pages.md' 157- 'Custom HTTP Headers' : 'features/custom-http-headers.md' 158- 'URL Rewrites' : 'features/url-rewrites.md' 159- 'URL Redirects' : 'features/url-redirects.md' 160- 'Windows Service' : 'features/windows-service.md' 161- 'Trailing Slash Redirect' : 'features/trailing-slash-redirect.md' 162- 'Ignore Files' : 'features/ignore-files.md' 163- 'Disable Symlinks' : 'features/disable-symlinks.md' 164- 'Health endpoint' : 'features/health-endpoint.md' 165- 'Metrics' : 'features/metrics.md' 166- 'Virtual Hosting' : 'features/virtual-hosting.md' 167- 'Multiple Index Files' : 'features/multiple-index-files.md' 168- 'Maintenance Mode' : 'features/maintenance-mode.md' 169- 'WebAssembly' : 'features/webassembly.md' 170- 'Man Pages and Shell Completions' : 'features/man-pages-completions.md' 171- 'Markdown Content Negotiation' : 'features/markdown-content-negotiation.md' 172- 'Default Charset for Text Responses' : 'features/text-charset.md' 173- 'Platforms & Architectures' : 'platforms-architectures.md' 174- 'Migrating from v1 to v2' : 'migration.md' 175- 'Changelog v2 (stable)' : 'https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md' 176- 'Changelog v1 (deprecated)' : 'https://github.com/static-web-server/static-web-server/releases/tag/v1.19.4' 177- 'Semantic Versioning' : 'semantic-versioning.md' 178- 'Report Security Issues' : 'report-security-issues.md' 179- 'Contributions' : 'contributions.md' 180- 'Showcases' : 'showcases.md' 181- 'License' : 'license.md' 182 183not_in_nav : | 184download-and-install.template.md 185 186# https://www.mkdocs.org/user-guide/configuration/#validation 187validation : 188omitted_files : warn 189absolute_links : warn 190unrecognized_links : warn 191anchors : warn