Skip to content

Garrett96/docusite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocuSite

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.

image

Requirements to use

  • GitHub Account
  • Vercel Account
  • Working knowledge of Markdown

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.
  • Sign into Vercel with your GitHub account. Add vercel permissions to your repo & then deploy.
  • Passwords are on by default but can be turned off in mkdocs.yml
  • Adjust the colors in custom.css.
  • Page editing is currently in raw markdown in an editor of your choice.

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

Legal

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

About

Bring your documentation online in minutes for free

Resources

License

Stars

Watchers

Forks