← Use Cases

Open Source Documentation

Give your open source project professional documentation without the overhead of maintaining a static site generator.

The problem

You built something great and pushed it to GitHub. Now you need docs. You could set up Docusaurus, configure GitHub Actions, manage a separate deployment. Or you could just write markdown files in your repo and let GetPagemark handle the rest.

How it works

Add a /docs folder to your repository (or use the whole repo). Connect it to GetPagemark. Pick a slug. Your documentation is live at slug.getpagemark.com with search, navigation, and dark mode. Every push rebuilds it.

Why it fits

Open source maintainers are busy. You shouldn't spend time on docs infrastructure. GetPagemark's free tier gives you one full docs site with subdomain, auto-deploy, and search. No credit card. No config files. Just markdown.

Private docs too

Building an open source project with private internal docs? GetPagemark supports private repos on all plans. Use the same workflow for public and internal documentation.

Example Structure

my-project/
├── docs/
│   ├── index.md
│   ├── getting-started.md
│   ├── api/
│   │   ├── overview.md
│   │   └── endpoints.md
│   └── contributing.md
├── src/
└── README.md

Set docs root to "docs" — only that folder gets built.

Ready to host your open source documentation?

Connect a GitHub repo. Get a docs site in 2 minutes.

Get started free