Deploy MkDocs Static Output
Build MkDocs with mkdocs build, ZIP the contents of site/, and deploy the generated browser assets on Linkyhost. Asset-only hosting; JavaScript output requires Pro.
Build Output for MkDocs
Build command
mkdocs buildZIP the contents of
site/ZIP the files inside the output directory
ZIP the contents of the generated output directory, with index.html at the ZIP root. Do not ZIP the project source directory. Uploading the project directory can expose source files and will not run a build on Linkyhost.
- If site_dir is set in mkdocs.yml, ZIP that configured directory.
How to Deploy MkDocs
Run mkdocs build.
ZIP the contents of site/ so index.html is at the ZIP root.
Upload the ZIP to Linkyhost, review the detected routing and configuration, then deploy.
SPA Routes, Redirects, and Headers
Put optional routing files in the generated output before you ZIP it. Deployment diagnostics report accepted and ignored rules.
SPA fallback
/* /index.html 200For a client-routed SPA, keep index.html at the output root. Linkyhost detects common browser-app builds automatically, or you can add /* /index.html 200 to _redirects. Exact assets and directory indexes always win before the fallback.
_redirects
/old /new 301Put a _redirects file at the output root for deployment redirects. Use one rule per line, such as /old /new 301; supported redirect statuses are 301, 302, 307, and 308. Framework redirects that require a server are not executed.
_headers
/assets/* Cache-Control: public, max-age=31536000
Put a _headers file at the output root for path-specific response headers. Start each block with a path, then indent allowlisted Name: value lines. Unsafe or platform-owned headers are ignored and reported in deployment diagnostics.
Build-output detection and diagnostics
Automatic HTTPS and CDN delivery
Validated redirects and response headers
Exact assets before optional SPA fallback
Frequently Asked Questions
What do I upload for a MkDocs deployment?
Run mkdocs build, then ZIP the contents of site/. The ZIP should open directly to index.html and browser assets, not another output folder or your project source.
Can Linkyhost run every MkDocs feature?
Linkyhost serves the files already present in your ZIP. It does not install dependencies, run a build, or provide Node.js, PHP, Python, Ruby, serverless functions, API routes, SSR, background jobs, or WebSockets.
Is a MkDocs deployment free?
Every multi-file website ZIP requires Pro, including HTML/CSS-only output and JavaScript framework builds. One standalone HTML page can use the Free plan.
How do SPA routes, redirects, and response headers work?
For a client-routed SPA, keep index.html at the output root. Linkyhost detects common browser-app builds automatically, or you can add /* /index.html 200 to _redirects. Exact assets and directory indexes always win before the fallback. Put a _redirects file at the output root for deployment redirects. Use one rule per line, such as /old /new 301; supported redirect statuses are 301, 302, 307, and 308. Framework redirects that require a server are not executed. Put a _headers file at the output root for path-specific response headers. Start each block with a path, then indent allowlisted Name: value lines. Unsafe or platform-owned headers are ignored and reported in deployment diagnostics.
Related Frameworks
Ready to Deploy MkDocs?
Build locally, ZIP the contents of site/, and upload it for detection and deployment diagnostics. HTML/CSS-only output can run free; output containing JavaScript requires Pro.
Upload a Build ZIP