Skip to content

Demo of how to deploy MkDocs docs site to Vercel (ZEIT Now)

Notifications You must be signed in to change notification settings

jenkincs/mkdocs-vercel-demo

 
 

Repository files navigation

MkDocs on Vercel

Screenshot 2020-05-13 at 10 27 14

Demo of how to deploy MkDocs site to Vercel (formerly ZEIT Now).

How to deploy

Just run now in this folder. (Tested as of now@19.)

Details

Note that for local development (yarn dev), Docker container is used so that it's not necessary to have Python and all the right extensions locally.

For cloud deployment, the two key parts are:

  • The requirements.txt file – Vercel will see it and treat the deployment as a Python project.
  • The build script in package.json – Vercel runs it on deployments. Note that this is not dockerized.

The awesome MkDocs Material theme is used, with a couple of customizations.

About

Demo of how to deploy MkDocs docs site to Vercel (ZEIT Now)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 94.9%
  • CSS 5.1%