← Guides
5 min

How to Host Documentation from a GitHub Repo

Turn any GitHub repository with markdown files into a live documentation site.

Step 1

Prepare your repo

Create a GitHub repository (or use an existing one) with .md files. At minimum, add an index.md at the root — this becomes your homepage. Organize into folders for sidebar sections.

my-docs/
├── index.md          → Homepage
├── getting-started.md → /getting-started
└── guide/
    ├── setup.md       → /guide/setup
    └── config.md      → /guide/config
Step 2

Sign in to GetPagemark

Go to getpagemark.com and sign in with your GitHub account. This grants GetPagemark read access to your repositories.

Step 3

Create a new site

Click "New Site" in the dashboard. Select your repository from the list. Choose the branch to build from (usually main). If your markdown files are in a subfolder, select the docs root folder.

Step 4

Pick a slug

Choose a URL slug for your site. This becomes your-slug.getpagemark.com. Slugs must be 3-63 characters, lowercase alphanumeric with hyphens.

Step 5

Your site is live

That's it. GetPagemark clones your repo, parses all markdown files, generates navigation from your folder structure, and serves it as a static site. Visit your-slug.getpagemark.com to see it.

Step 6

Auto-update on push

Set up a GitHub webhook pointing to https://api.getpagemark.com/webhook/github so your site rebuilds automatically on every push. Or use the manual rebuild button in the dashboard.

Ready to try it?

Get started free