📚 Make code documentation people can use

Grow polished documentation from Markdown.

Get startedRepository

• Existing-project friendlyStart with the README and docs you already have.
• Polished with little setupBuild a searchable documentation site from Markdown.
• Versioned documentationKeep released guides available side by side.
• Offline/local assetsBuilt sites work without a CDN.

DocSprout turns Markdown into a searchable, responsive documentation website for code projects. It originated in the Free Pascal ecosystem and remains Pascal-friendly, but the input is ordinary Markdown, not Pascal source code.

🧭 Pick one goal

• I want a working site first. Follow the beginner’s guide. When you need the static files, or a ZIP to hand to someone, read Build and inspect your site.
• I already have a repository and docs. Start with Add DocSprout to an existing repository.
• I want to write clearer guides. Read Write documentation people can use.
• I want to add or reorder pages. Open Configuration.
• I want to change the look. Try Themes or customize the home page.
• I want to publish. Run docsprout github-pages, then follow GitHub Pages.
• I want the checks in my pipeline. Read Checks in CI and CD.
• I want to catch broken public docs. Run docsprout audit and read the audit guide.
• I want to know what is tested and supported. Read the qualification evidence.
• A word is unfamiliar. Check the glossary.
• A command failed. Find the message in Troubleshooting.

✨ What stays simple

Your project owns its words, Markdown files and visual identity. DocSprout owns the shared page layout, search, themes, validation and publishing machinery. Everything needed to browse a built site is stored locally, so the site does not depend on a hosted JavaScript or CSS service.

DocSprout does not extract API descriptions from source code. Free Pascal projects can use PasWeave for that job and feed the resulting Markdown into DocSprout.