Published on push
We install the webhook. Merge a pull request and the docs follow, with no build step to maintain.
For open source projects
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.
Installation
Install Fieldkit with your package manager, then run the init command in your project.
Fieldkit needs Node 20 or later.
§ 01 · Why it fits
Markdown in your repository, published on every push, with edit links back to GitHub for contributors.
We install the webhook. Merge a pull request and the docs follow, with no build step to maintain.
An "Edit this page" link opens the file on GitHub, so typo fixes arrive as pull requests.
Full-text search, and an MCP endpoint so AI assistants answer from your real docs.
Laradocs, the open-source package behind Maddie Docs, renders the same pages in your own Laravel app.
§ 02 · Included
Your directory structure is the sidebar.
Set titles, order, descriptions and tags in each file.
Highlighted, labelled and copyable.
docs.yourproject.dev on Starter and Pro.
Sync from a private repo and publish only the docs.
Every page ready for search engines and link previews.
§ 03 · Where to start
Start on Free with one synced site. Starter adds docs.yourproject.dev.
§ 04 · Questions
The Free plan includes one site synced from GitHub on a free subdomain. Starter adds a custom domain.
No. Connect the repository and we install a webhook; each push updates the site from your Markdown.
Yes. The site owner's GitHub connection can read private repositories. Only the published docs are public.
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.
Also made for
Write it in the browser, publish it in a click. Your tenth will take less.