- 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.
The Site directory will always be overwritten when mkdocs build runs. You never need to touch that file.
1] Fork the repository.
2] Sign into Vercel with your GitHub account. Add vercel permissions to the forked repository.
3] Deploy the repository on Vercel. Check that the generated URL works.
4] Jump straight into editing the markdown files inside of GitHub.
1] On your personal Github profile, create a new empty private repository.
2] Clone the DocuSite repository
git clone --bare https://github.com/Garrett96/docusite/
3] Mirror-push the cloned repository to the empty private repo created in step #1
cd docusite.git
git push --mirror https://github.com/your-username/new-private-repo.git
4] Delete the cloned DocuSite repository since you don't need it anymore
cd ..
rm -rf original-repository.git
5] Clone your new private repo created in Step #1
git clone https://github.com/your-username/new-private-repo.git
6] Sign into Vercel with your GitHub account. Add vercel permissions to your private repo & then deploy on Vercel.
7] (Optional) If you would like to keep the private repository open to future downstream changes:
git remote add upstream https://github.com/Garrett96/docusite/
git remote set-url --push upstream DISABLE
A] Clone the Repo with GitHub Desktop and open with your preferred IDE for a more comfortable experience editing content and adding image assets.
B] In mkdocs.yml uncomment password plugin and set a global password.
- DocuSite: Licensed under the MIT License.
- MkDocs: Licensed under the BSD-2-Clause License.
- Vercel: Terms of Service