https://github.com/borekb/mkdocs-vercel-demo

Demo of how to deploy MkDocs docs site to Vercel (ZEIT Now)
https://github.com/borekb/mkdocs-vercel-demo

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/borekb/mkdocs-vercel-demo
• Owner: borekb
• Created: 2020-05-13T08:25:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-13T08:29:21.000Z (over 4 years ago)
• Last Synced: 2024-10-19T06:06:04.352Z (29 days ago)
• Language: HTML
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MkDocs on Vercel



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](https://squidfunk.github.io/mkdocs-material/) theme is used, with a couple of customizations.