Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.12 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.12 KB

DocuSite || MkDocs with Vercel

Bring your documentation online in minutes for free

  • Easy setup and works right out of the box.
  • No project file configuration required to get started.
  • Optional password protection for page content.
  • 100% free.
Screen Shot 2024-09-11 at 01 43 25

Instructions

The Site directory will always be overwritten when mkdocs build runs. You never need to touch that file.

Setup

Clone the Repo (I recommend using GitHub Desktop)

Find the file in Github folder and open it, can push your changes easily that way.

In mkdocs.yml uncomment password plugin and set a global password if you want to.

Sign into Vercel with your GitHub account. Add vercel permissions to your repo & then deploy.

go to the custom.css to change the colors at the top if you want.

Legal

  • DocuSite: Licensed under the MIT License.
  • MkDocs: Licensed under the BSD-2-Clause License.
  • Vercel: Terms of Service