For open source projects

Docs that update when you merge.

Keep Markdown in your repository and the site updates on every push. Folders become the sidebar, search works out of the box, and every page links back to GitHub so contributors can fix it.

Fieldkit

Installation

Install Fieldkit with your package manager, then run the init command in your project.

Tip

Fieldkit needs Node 20 or later.

§ 01 · Why it fits

Built for maintainers.

Markdown in your repository, published on every push, with edit links back to GitHub for contributors.

01

Published on push

We install the webhook. Merge a pull request and the docs follow, with no build step to maintain.

02

Contributors can fix pages

An "Edit this page" link opens the file on GitHub, so typo fixes arrive as pull requests.

03

Search and AI built in

Full-text search, and an MCP endpoint so AI assistants answer from your real docs.

04

Or host it yourself

Laradocs, the open-source package behind Maddie Docs, renders the same pages in your own Laravel app.

§ 02 · Included

What you get out of the box.

Folders become navigation

Your directory structure is the sidebar.

Front-matter

Set titles, order, descriptions and tags in each file.

Code blocks

Highlighted, labelled and copyable.

Your domain

docs.yourproject.dev on Starter and Pro.

Private repositories

Sync from a private repo and publish only the docs.

Sitemap and share cards

Every page ready for search engines and link previews.

§ 03 · Where to start

Start on Free.

Start on Free with one synced site. Starter adds docs.yourproject.dev.

§ 04 · Questions

Before you start.

Is there a free plan for open source?

The Free plan includes one site synced from GitHub on a free subdomain. Starter adds a custom domain.

Do we need a build step or CI job?

No. Connect the repository and we install a webhook; each push updates the site from your Markdown.

Can we sync from a private repository?

Yes. The site owner's GitHub connection can read private repositories. Only the published docs are public.

Can we self-host instead?

Yes. Laradocs, the free open-source Laravel package that Maddie Docs is built on, renders the same docs from a folder of Markdown in your own app.

Your first page can be live in five minutes.

Write it in the browser, publish it in a click. Your tenth will take less.